-
Notifications
You must be signed in to change notification settings - Fork 138
/
Copy pathGeneralLoopUnroller.cpp
4370 lines (3831 loc) · 173 KB
/
GeneralLoopUnroller.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
/*******************************************************************************
* Copyright IBM Corp. and others 2000
*
* This program and the accompanying materials are made available under
* the terms of the Eclipse Public License 2.0 which accompanies this
* distribution and is available at https://www.eclipse.org/legal/epl-2.0/
* or the Apache License, Version 2.0 which accompanies this distribution
* and is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License, v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception [1] and GNU General Public
* License, version 2 with the OpenJDK Assembly Exception [2].
*
* [1] https://www.gnu.org/software/classpath/license.html
* [2] https://openjdk.org/legal/assembly-exception.html
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
*******************************************************************************/
#include "optimizer/GeneralLoopUnroller.hpp"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <algorithm>
#include "codegen/CodeGenerator.hpp"
#include "env/FrontEnd.hpp"
#include "codegen/RecognizedMethods.hpp"
#include "compile/Compilation.hpp"
#include "compile/SymbolReferenceTable.hpp"
#include "control/Options.hpp"
#include "control/Options_inlines.hpp"
#include "cs2/bitvectr.h"
#include "env/StackMemoryRegion.hpp"
#include "env/jittypes.h"
#include "il/AliasSetInterface.hpp"
#include "il/AutomaticSymbol.hpp"
#include "il/LabelSymbol.hpp"
#include "il/MethodSymbol.hpp"
#include "il/Node.hpp"
#include "il/Node_inlines.hpp"
#include "il/ResolvedMethodSymbol.hpp"
#include "il/TreeTop.hpp"
#include "infra/Cfg.hpp"
#include "infra/CfgEdge.hpp"
#include "infra/CfgNode.hpp"
#include "optimizer/Optimization_inlines.hpp"
#include "optimizer/Optimizer.hpp"
#include "optimizer/Structure.hpp"
#include "optimizer/TransformUtil.hpp"
#include "ras/Debug.hpp"
#define OPT_DETAILS "O^O GENERAL LOOP UNROLLER: "
#define OPT_DETAILS1 "O^O ARRAY ALIASING REFINER: "
#define GET_CLONE_BLOCK(x) _blockMapper[_iteration%2][(x)->getNumber()]
#define SET_CLONE_BLOCK(x,y) _blockMapper[_iteration%2][(x)->getNumber()]=(y)
#define GET_CLONE_NODE(x) _nodeMapper[_iteration%2][(x)->getNumber()]
#define SET_CLONE_NODE(x,y) _nodeMapper[_iteration%2][(x)->getNumber()]=(y)
#define GET_PREV_CLONE_BLOCK(x) _blockMapper[(1+_iteration)%2][(x)->getNumber()]
#define GET_PREV_CLONE_NODE(x) _nodeMapper[(1+_iteration)%2][(x)->getNumber()]
#define CURRENT_MAPPER _iteration%2
#define CREATED_BY_GLU 9
// Aliasing based weight analysis
class LoopWeightProbe
{
public:
LoopWeightProbe(TR::Compilation *comp) :
_numUsed(0), _numKilled(0), _numMatConst(0), _numUnmatConst(0),
_numCalls(0), _numLeafRoutines(0), _numPureFunctions(0), _numBIFs(0),
_used(comp->allocator()), _defd(comp->allocator()) {}
uint32_t _numUsed;
uint32_t _numKilled;
uint32_t _numMatConst;
uint32_t _numUnmatConst;
uint32_t _numCalls;
uint32_t _numLeafRoutines;
uint32_t _numPureFunctions;
uint32_t _numBIFs; // Builtins; RecognizedMethods
TR::BitVector _used;
TR::BitVector _defd;
};
static TR::ILOpCodes getConstOpCode(TR::DataType type)
{
switch (type.getDataType())
{
case TR::Int8: return TR::bconst;
case TR::Int16: return TR::sconst;
case TR::Int32: return TR::iconst;
case TR::Int64: return TR::lconst;
case TR::Address: return TR::comp()->target().is64Bit() ? TR::lconst : TR::iconst;
default:
TR_ASSERT(false, "unsupported type");
return TR::iconst;
}
TR_ASSERT(false, "unsupported type");
return TR::iconst;
}
static TR_ScratchList<TR::CFGEdge> *join(TR_ScratchList<TR::CFGEdge> *to, TR_ScratchList<TR::CFGEdge> *from)
{
if (from == NULL)
return to;
if (to == NULL)
return from;
ListIterator<TR::CFGEdge> it(from);
for (TR::CFGEdge *edge = it.getCurrent(); edge; edge = it.getNext())
to->add(edge);
return to;
}
static TR_ScratchList<TR::CFGEdge> *findCorrespondingCFGEdges(TR_Structure *from, TR_Structure *to, TR::Compilation * comp)
{
if (from->asBlock())
{
TR::Block *block = from->asBlock()->getBlock();
for (auto edge = block->getSuccessors().begin(); edge != block->getSuccessors().end(); ++edge)
{
TR::Block *succ = toBlock((*edge)->getTo());
if (to->contains(succ->getStructureOf()))
return new (comp->trHeapMemory()) TR_ScratchList<TR::CFGEdge>(*edge, comp->trMemory());
}
return NULL;
}
else
{
TR_ScratchList<TR::CFGEdge> *edges = NULL;
TR_RegionStructure::Cursor it(*(from->asRegion()));
TR_StructureSubGraphNode *node;
for (node = it.getFirst(); node; node = it.getNext())
edges = join(edges, findCorrespondingCFGEdges(node->getStructure(), to, comp));
return edges;
}
}
static bool isBranchAtEndOfLoop(TR_RegionStructure *loop, TR::Block *branchBlock)
{
for (auto e = branchBlock->getSuccessors().begin(); e != branchBlock->getSuccessors().end(); ++e)
{
if ((*e)->getTo()->getNumber() == loop->getEntryBlock()->getNumber())
return true;
}
return false;
}
bool TR_LoopUnroller::nodeRefersToSymbol(TR::Node *node, TR::Symbol *sym)
{
if (!node) return false;
if (node->getOpCode().hasSymbolReference() && node->getSymbol() == sym)
return true;
for (int32_t child = 0; child < node->getNumChildren(); child++)
if (nodeRefersToSymbol(node->getChild(child), sym))
return true;
return false;
}
TR::Symbol *TR_LoopUnroller::findSymbolInTree(TR::Node *node)
{
if (!node) return NULL;
if (node->getOpCode().hasSymbolReference())
return node->getSymbol();
for (int32_t child = node->getNumChildren() - 1; child >= 0; child--)
{
TR::Symbol *sym;
if ((sym = findSymbolInTree(node->getChild(child))))
return sym;
}
return NULL;
}
static bool checkNodeFrequency(TR_StructureSubGraphNode *subNode, TR_RegionStructure *loop)
{
TR::Block *block = subNode->getStructure()->asBlock() != NULL ? subNode->getStructure()->asBlock()->getBlock() : NULL;
return !block || loop->getEntryBlock()->getFrequency() < 5000 || block->getFrequency() > 2000 || block->getFrequency() == -1;
}
static bool hasConnectableEdges(TR::Compilation *comp, TR_RegionStructure *loop)
{
if (!TR::isJ9() || comp->getOption(TR_DisableGLUColdRedirection))
return true;
TR_RegionStructure::Cursor nodeIt(*loop);
TR_StructureSubGraphNode *subNode;
bool connectable = false;
for (subNode = nodeIt.getFirst(); subNode; subNode = nodeIt.getNext())
{
for (auto edge = subNode->getSuccessors().begin(); edge != subNode->getSuccessors().end(); ++edge)
{
TR_StructureSubGraphNode *succ = toStructureSubGraphNode((*edge)->getTo());
if (succ == loop->getEntry())
{
if (checkNodeFrequency(subNode, loop))
{
connectable = true;
break;
}
}
}
}
return connectable;
}
bool TR_LoopUnroller::shouldConnectToNextIteration(TR_StructureSubGraphNode *subNode, TR_RegionStructure *loop)
{
if (!TR::isJ9() || comp()->getMethodHotness() <= warm || comp()->getOption(TR_DisableGLUColdRedirection))
return true;
if (!hasConnectableEdges(comp(), loop))
return true;
return _unrollKind == CompleteUnroll || isCountedLoop() || checkNodeFrequency(subNode, loop);
}
void TR_LoopUnroller::unrollLoopOnce(TR_RegionStructure *loop, TR_StructureSubGraphNode *branchNode,
bool finalUnroll)
{
TR_StructureSubGraphNode *newEntryNode = NULL;
//Reset the mappers.
memset(_blockMapper[CURRENT_MAPPER], 0, _numNodes * sizeof(TR::Block *));
memset( _nodeMapper[CURRENT_MAPPER], 0, _numNodes * sizeof(TR_StructureSubGraphNode *));
//First, clone all the original blocks in the loop
cloneBlocksInRegion(loop);
//Create duplicates of all sub structures in the loop
TR_RegionStructure::Cursor nodeIt(*loop);
TR_StructureSubGraphNode *subNode;
for (subNode = nodeIt.getFirst(); subNode; subNode = nodeIt.getNext())
{
if (subNode->getNumber() >= _numNodes)
continue; //clone only original nodes
//Clone all the substructures
TR_Structure *subStruct = subNode->getStructure();
TR_Structure *clonedSubStruct = cloneStructure(subStruct);
TR_StructureSubGraphNode *clonedSubNode = new (_cfg->structureMemoryRegion()) TR_StructureSubGraphNode(clonedSubStruct);
//Memorize the mapping between subNode and clonedSubNode
SET_CLONE_NODE(subNode, clonedSubNode);
//Add it to the loop
loop->addSubNode(clonedSubNode);
if (subNode == loop->getEntry())
newEntryNode = clonedSubNode;
}
//Fix all the exit edges in the subnodes
nodeIt.reset();
for (subNode = nodeIt.getFirst(); subNode; subNode = nodeIt.getNext())
{
if (subNode->getNumber() >= _numNodes)
continue;
TR_StructureSubGraphNode *clonedSubNode = GET_CLONE_NODE(subNode);
if (clonedSubNode)
/*GGLU*/
{
if (isCountedLoop())
fixExitEdges(subNode->getStructure(), clonedSubNode->getStructure());
else
fixExitEdges(subNode->getStructure(), clonedSubNode->getStructure(), branchNode);
}
}
if (_iteration == 1)
_firstEntryNode = newEntryNode;
//Now Fixup the structure edges
TR_StructureSubGraphNode *clonedBranchNode = GET_CLONE_NODE(branchNode);
/*GGLU*/
//First of all, remove the branch
bool branchAtEnd = true;
if (isCountedLoop())
{
// If the exit branch is in the middle of the loop and a complete unroll is going
// to happen, it is not valid to remove the branch for the last unroll (the top half
// of the loop maybe executed more number of times compared to the bottom half)
//
if (finalUnroll && _unrollKind == CompleteUnroll)
{
branchAtEnd = isBranchAtEndOfLoop(loop, branchNode->getStructure()->asBlock()->getBlock());
}
if (branchAtEnd)
clonedBranchNode->getStructure()->asBlock()->getBlock()->removeBranch(comp());
}
//Look at all the structures edges in the original loop, and create appropriate edges
//for each edge type (described below).
nodeIt.reset();
for (subNode = nodeIt.getFirst(); subNode; subNode = nodeIt.getNext())
{
if (subNode->getNumber() >= _numNodes)
continue;
TR_StructureSubGraphNode *clonedSubNode = GET_CLONE_NODE(subNode);
//Now iterate over all the edges originating from subnode and replicate
//them, if possible, for the clone
bool subNodeHasBackEdge = false;
for (auto edge = subNode->getSuccessors().begin(); edge != subNode->getSuccessors().end(); ++edge)
{
TR_StructureSubGraphNode *succ = toStructureSubGraphNode((*edge)->getTo());
if (succ == loop->getEntry())
{
subNodeHasBackEdge = true;
break;
}
}
for (auto edge = subNode->getSuccessors().begin(); edge != subNode->getSuccessors().end(); ++edge)
{
TR_StructureSubGraphNode *succ = toStructureSubGraphNode((*edge)->getTo());
TR_StructureSubGraphNode *clonedSucc = GET_CLONE_NODE(succ);
//Edges are classified into 4 Categories:
//A: exit edge originating from the branch node
//B: exit edge not originating from the branch node
//C: back edge to the entry node
//D: internal edges other than the backedges
if (subNode == branchNode && !clonedSucc) //Type A
{
/*GGLU*/
bool fixBranch = true;
if (isCountedLoop())
{
//nothing to do, removed branch above.
fixBranch = false;
//branch not removed if a complete unroll is being done
//and it is in the middle of the loop
if (finalUnroll && _unrollKind == CompleteUnroll && !branchAtEnd)
fixBranch = true;
}
if (fixBranch)
{
addExitEdgeAndFixEverything(loop, *edge, clonedSubNode);
}
}
else if (subNode != branchNode && !clonedSucc) //Type B
{
EdgeContext context = InvalidContext;
if (finalUnroll &&
(_unrollKind == CompleteUnroll) &&
subNodeHasBackEdge)
context = BackEdgeFromLastGenerationCompleteUnroll;
addExitEdgeAndFixEverything(loop, *edge, clonedSubNode, NULL, NULL, context);
}
else if (succ == loop->getEntry()) //Type C
{
//We have a backedge of the form Edge(A -> E).
//
//If this is the final unrolling, and we are not unrolling completely,
// add edges back to the original entry pt. (back edges to the true
// entry of the loop)
// ie, we must create (A' -> E) instead of (A' -> E').
//
//If this is the final unrolling, and We are going to unroll the loop
// completely, add (A' -> X) where X is the exit destination of the
// loop.
//
//For all iterations, except the first,
// add and edge from the previous generation's A to the entry
// point of this unrolling. ie. (A(prev) -> E(current))
//
if (finalUnroll)
{
if (_unrollKind != CompleteUnroll)
//Add an edge from the cloned subnode to the original entry
addEdgeAndFixEverything(loop, *edge, clonedSubNode, loop->getEntry(),
false, false, true, BackEdgeToEntry);
else
{
//add an edge to the exit destination
//(loop, edge, clonedSubnode, exitDestination, false, false, false,
// RedirectBackEdgeToExitDestination
redirectBackEdgeToExitDestination(loop, branchNode, clonedSubNode, (subNode != branchNode));
}
}
if (_iteration != 1) //for all iterations except the first iteration
{
if (shouldConnectToNextIteration(toStructureSubGraphNode(subNode), loop))
{
addEdgeAndFixEverything(loop, *edge, GET_PREV_CLONE_NODE(subNode), newEntryNode,
false, false, false, BackEdgeFromPrevGeneration);
}
else
{
if (trace())
traceMsg(comp(), "Redirecting cold edge from block_%d to unrolled loop header rather than going to the next iteration\n", subNode->getNumber());
addEdgeAndFixEverything(loop, *edge, GET_PREV_CLONE_NODE(subNode), loop->getEntry(),
false, false, true, BackEdgeToEntry);
}
}
}
else //Type D
{
addEdgeAndFixEverything(loop, *edge);
}
}
}
processSwingQueue();
if (trace())
{
traceMsg(comp(), "\nstructure after cloning the loop for the %dth time:\n\n", _iteration);
getDebug()->print(comp()->getOutFile(), _rootStructure, 6);
getDebug()->print(comp()->getOutFile(), _cfg);
comp()->dumpMethodTrees("method trees:");
}
//We are done.
}
void TR_LoopUnroller::redirectBackEdgeToExitDestination(TR_RegionStructure *loop,
TR_StructureSubGraphNode *branchNode,
TR_StructureSubGraphNode *fromNode,
bool notLoopBranchNode)
{
//Find the exit destination
TR::CFGEdge *exitEdge = NULL;
for (auto edge = branchNode->getSuccessors().begin(); (edge != branchNode->getSuccessors().end()) && exitEdge == NULL; ++edge)
{
if (loop->isExitEdge(*edge))
exitEdge = *edge;
}
//Add A->X*
addEdgeForSpillLoop
(loop, exitEdge, fromNode,
findNodeInHierarchy(loop->getParent()->asRegion(),
toStructureSubGraphNode(exitEdge->getTo())->getNumber()),
false,
BackEdgeFromLastGenerationCompleteUnroll,
notLoopBranchNode);
}
void TR_LoopUnroller::modifyBranchTree(TR_RegionStructure *loop,
TR_StructureSubGraphNode *loopNode,
TR_StructureSubGraphNode *branchNode)
{
TR_ASSERT(isCountedLoop() && _unrollKind != CompleteUnroll && _spillLoopRequired,
"GLU: modifying branch tree under wrong set of conditions");
TR::Block *branchBlock = branchNode->getStructure()->asBlock()->getBlock();
TR::Node *branch = branchBlock->getLastRealTreeTop()->getNode();
TR_RegionStructure *parent = loop->getParent()->asRegion();
TR_StructureSubGraphNode *predNode = toStructureSubGraphNode
(loopNode->getPredecessors().front()->getFrom());
TR_BlockStructure *predBlock = predNode->getStructure()->asBlock();
TR_ASSERT(predBlock, "Interesting... loop-invariant block is not a block");
TR::Block *pBlock = predBlock->getBlock();
// if the loop was the first block in the method, pBlock won't have real
// entry/exit trees. Add a dummy block at head
//
if (pBlock->getEntry() == 0)
{
TR::Block *newBlock = TR::Block::createEmptyBlock(branch, comp(), MAX_COLD_BLOCK_COUNT+1, pBlock); //branchBlock->getFrequency());
newBlock->getExit()->join(loop->getEntryBlock()->getEntry());
comp()->setStartTree(newBlock->getEntry());
_cfg->addNode(newBlock);
TR_BlockStructure *newBlockStr = new (_cfg->structureMemoryRegion()) TR_BlockStructure(comp(), newBlock->getNumber(), newBlock);
TR_StructureSubGraphNode *newNode = new (_cfg->structureMemoryRegion()) TR_StructureSubGraphNode(newBlockStr);
parent->addSubNode(newNode);
TR::CFGEdge *edgeToRemove = pBlock->getSuccessors().front();
_cfg->addEdge(TR::CFGEdge::createEdge(pBlock, newBlock, trMemory()));
TR::CFGEdge::createEdge(predNode, newNode, trMemory());
_cfg->addEdge(TR::CFGEdge::createEdge(newBlock, loop->getEntryBlock(), trMemory()));
TR::CFGEdge::createEdge(newNode, loopNode, trMemory());
_cfg->removeEdge(edgeToRemove);
parent->removeEdge(predBlock, loopNode->getStructure());
predNode = newNode;
predBlock = newBlockStr;
pBlock = newBlock;
}
TR::Block *spillBlock = _spillNode->getStructure()->asRegion()->getEntryBlock();
// 1- Change the bound node in the loop-test.
// N gets replaced by N-(ku-1) or N-(ku+1) (increasing or decreasing loops)
// If the bound is a constant - replace the constant in-place.
// Else save the new bound in a temporary outside the loop.
//
TR::Node *originalLimitNode = branch->getSecondChild();
TR::Node *newLimitNode = NULL;
int32_t adjustment = getLoopStride() * (1+_unrollCount) +
(isIncreasingLoop() ? -1 : 1);
bool const_overflow = false;
bool is64BitComparison = TR::DataType::getSize(getTestChildType()) == 8 ? true : false;
// check for overflow if upper bound is constant
if (originalLimitNode->getOpCode().isLoadConst() &&
getTestIsUnsigned() )
{
// Address compare generated by loop strider does not have constant node,
// thus should not fall into this category
TR_ASSERT(!originalLimitNode->getType().isAddress(), "Counted loop with a constant address limit node is unexpected, test node is %p", getTestNode());
// TODO: don't unroll such loops
if(getTestChildType().isInt32())
{
unsigned utemp = originalLimitNode->getUnsignedInt() - adjustment;
const_overflow = (isIncreasingLoop() && originalLimitNode->getUnsignedInt() < utemp) ||
(!isIncreasingLoop() && originalLimitNode->getUnsignedInt() > utemp);
}
else if(getTestChildType().isInt64())
{
uint64_t utemp = originalLimitNode->getUnsignedLongInt() - adjustment;
const_overflow = (isIncreasingLoop() && originalLimitNode->getUnsignedLongInt() < utemp) ||
(!isIncreasingLoop() && originalLimitNode->getUnsignedLongInt() > utemp);
}
}
//TR_ASSERT(!const_overflow, "Unroll count is bigger than upper bound\n");
if (originalLimitNode->getOpCode().isLoadConst() && !const_overflow)
{
// Address compare generated by loop strider does not have constant node,
// thus should not fall into this category
TR_ASSERT(!originalLimitNode->getType().isAddress(), "Counted loop with a constant address limit node is unexpected, test node is %p", getTestNode());
newLimitNode = TR::Node::create(branch, getConstOpCode(getTestChildType()));
if (getTestChildType().isInt32())
newLimitNode->setInt(originalLimitNode->getInt() - adjustment);
else
newLimitNode->setLongInt(originalLimitNode->getLongInt() - adjustment);
branch->setAndIncChild(1, newLimitNode);
}
else
{
// Hoist computation outside loop, with a test for overflow
//
TR::TreeTop *storeToTempTT;
TR::Node *storeToTemp;
TR::Node *originalLimitClone = originalLimitNode->duplicateTree();
TR::Node *tempValue = NULL;
TR::SymbolReference *tempSym;
if (getIndexType().isAddress())
{
tempSym = comp()->getSymRefTab()->createTemporary(comp()->getMethodSymbol(), TR::Address, true);
tempSym->getSymbol()->castToInternalPointerAutoSymbol()->setPinningArrayPointer
(_piv->getSymRef()->getSymbol()->castToInternalPointerAutoSymbol()->getPinningArrayPointer());
}
else
tempSym = comp()->getSymRefTab()->createTemporary(comp()->getMethodSymbol(), getTestChildType().getDataType());
TR::Node *constNode = TR::Node::create(branch, getConstOpCode(getTestChildType()), 0);
TR::ILOpCodes storeOpCode;
// if (getTestIsUnsigned())
// {
// if (getTestChildType().isInt32())
// constNode->setInt(adjustment);
// else
// constNode->setLongInt(adjustment);
// TR::ILOpCodes addOpCode = getTestChildType().isInt64() ? TR::lsub : TR::isub;
// tempValue = TR::Node::create(addOpCode, 2,originalLimitClone, constNode);
// storeOpCode = getTestChildType().isInt64() ? TR::lstore : TR::istore;
// }
// else
// {
if (!is64BitComparison)
constNode->setInt(-adjustment);
else
constNode->setLongInt(-adjustment);
TR::ILOpCodes addOpCode = getIndexType().isAddress() ?
(is64BitComparison ? TR::aladd : TR::aiadd) :
(is64BitComparison ? TR::ladd : TR::iadd) ;
tempValue = TR::Node::create(addOpCode, 2,originalLimitClone, constNode);
if (getIndexType().isAddress())
{
tempValue->setPinningArrayPointer
(_piv->getSymRef()->getSymbol()->castToInternalPointerAutoSymbol()->getPinningArrayPointer());
tempValue->setIsInternalPointer(true);
}
storeOpCode = getIndexType().isAddress() ?
TR::astore :
(is64BitComparison ? TR::lstore : TR::istore);
// }
storeToTemp = TR::Node::createWithSymRef(storeOpCode, 1, 1, tempValue, tempSym);
storeToTempTT = TR::TreeTop::create(comp(), storeToTemp);
newLimitNode = TR::Node::createLoad(branch, tempSym);
if (getIndexType().isAddress() || getTestChildType().isAddress())
{
TR_ASSERT(getIndexType().isAddress() && getTestChildType().isAddress(), "Test child type and IV type should both be address");
}
else if (newLimitNode->getType().isAggregate() && !getTestChildType().isAggregate())
{
TR::ILOpCodes o2xOp = TR::ILOpCode::getProperConversion(newLimitNode->getDataType(), getTestChildType().getDataType(), true);
TR_ASSERT(o2xOp != TR::BadILOp,"could not find conv op for %s -> %s conversion\n",TR::DataType::getName(newLimitNode->getDataType()),TR::DataType::getName(getTestChildType().getDataType()));
newLimitNode = TR::Node::create(o2xOp, 1, newLimitNode);
}
branch->setAndIncChild(1, newLimitNode);
TR::TreeTop *lastTree = pBlock->getLastRealTreeTop();
if (lastTree->getNode()->getOpCode().isBranch())
{
// Splice the block into two, putting the goto in the next block
TR_ASSERT(lastTree->getNode()->getOpCodeValue() == TR::Goto, "expecting canon loops");
TR::Block *newBlock = TR::Block::createEmptyBlock(lastTree->getNode(), comp(), pBlock->getFrequency(), pBlock);
lastTree->getPrevTreeTop()->join(lastTree->getNextTreeTop());
newBlock->append(lastTree);
newBlock->getExit()->join(pBlock->getNextBlock()->getEntry());
pBlock->getExit()->join(newBlock->getEntry());
_cfg->addNode(newBlock);
TR_BlockStructure *newBlockStructure = new (_cfg->structureMemoryRegion()) TR_BlockStructure(comp(), newBlock->getNumber(), newBlock);
TR_StructureSubGraphNode *newSubNode = new (_cfg->structureMemoryRegion()) TR_StructureSubGraphNode(newBlockStructure);
parent->addSubNode(newSubNode);
TR::CFGEdge *edgeToRemove = pBlock->getSuccessors().front();
_cfg->addEdge(TR::CFGEdge::createEdge(pBlock, newBlock, trMemory()));
TR::CFGEdge::createEdge(predNode, newSubNode, trMemory());
_cfg->addEdge(TR::CFGEdge::createEdge(newBlock, loop->getEntryBlock(), trMemory()));
TR::CFGEdge::createEdge(newSubNode, loopNode, trMemory());
_cfg->removeEdge(edgeToRemove);
parent->removeEdge(predBlock, loopNode->getStructure());
}
// create the n, n - 3 test (overflow test)
TR::ILOpCodes opCode;
if (getIndexType().isAddress())
{
opCode = isIncreasingLoop() ? TR::ifacmplt : TR::ifacmpgt;
}
else
{
if (getTestIsUnsigned())
{
if (getTestChildType().isInt32())
opCode = isIncreasingLoop() ? TR::ifiucmplt : TR::ifiucmpgt;
else
opCode = isIncreasingLoop() ? TR::iflucmplt : TR::iflucmpgt;
}
else
{
if (getTestChildType().isInt32())
opCode = isIncreasingLoop() ? TR::ificmplt : TR::ificmpgt;
else
opCode = isIncreasingLoop() ? TR::iflcmplt : TR::iflcmpgt;
}
}
TR::Node *c2 = tempValue;
pBlock->append(storeToTempTT);
pBlock->append(TR::TreeTop::create(comp(), TR::Node::createif(opCode,
originalLimitClone, c2,
spillBlock->getEntry())));
_overflowTestBlock = pBlock;
_cfg->addEdge(TR::CFGEdge::createEdge(pBlock, spillBlock, trMemory()));
TR::CFGEdge::createEdge(predNode, _spillNode, trMemory());
}
originalLimitNode->recursivelyDecReferenceCount();
if (trace())
{
comp()->dumpMethodTrees("\nbefore adding the loopiter test");
getDebug()->print(comp()->getOutFile(), _rootStructure, 6);
}
// add the minimum loop iteration test after the overflow test
//
if (1) /// moveEntryNode
{
TR::ILOpCodes opCode = _branchToExit ?
branch->getOpCodeValue() : /* use same polarity */
branch->getOpCode().getOpCodeForReverseBranch();
TR::TreeTop *lastTree = pBlock->getLastRealTreeTop();
TR::Node *firstChild = TR::Node::createLoad(branch, _piv->getSymRef());
if (getIndexType().isAddress() || getTestChildType().isAddress())
{
TR_ASSERT(getIndexType().isAddress() && getTestChildType().isAddress(), "Test child type and IV type should both be address");
}
else if (firstChild->getType().isAggregate() && !getTestChildType().isAggregate())
{
TR::ILOpCodes o2xOp = TR::ILOpCode::getProperConversion(firstChild->getDataType(), getTestChildType().getDataType(), true);
TR_ASSERT(o2xOp != TR::BadILOp,"could not find conv op for %s -> %s conversion\n",TR::DataType::getName(firstChild->getDataType()),TR::DataType::getName(getTestChildType().getDataType()));
firstChild = TR::Node::create(o2xOp, 1, firstChild);
}
else if (getIndexType().isInt16())
{
if (getTestChildType().isInt64())
firstChild = TR::Node::create(TR::s2l, 1, firstChild);
else if (getTestChildType().isInt32())
firstChild = TR::Node::create(TR::s2i, 1, firstChild);
}
else if (getIndexType().isInt8())
{
if (getTestChildType().isInt64())
firstChild = TR::Node::create(TR::b2l, 1, firstChild);
else if (getTestChildType().isInt32())
firstChild = TR::Node::create(TR::b2i, 1, firstChild);
else if (getTestChildType().isInt16())
firstChild = TR::Node::create(TR::b2s, 1, firstChild);
}
else if (getIndexType().isInt32() && getTestChildType().isInt64())
{
firstChild = TR::Node::create(TR::i2l, 1, firstChild);
}
else if (getIndexType().isInt64() && getTestChildType().isInt32())
{
firstChild = TR::Node::create(TR::l2i, 1, firstChild);
}
TR::Node *dupNewLimit = newLimitNode->duplicateTree();
if (loop->getPrimaryInductionVariable() &&
loop->getPrimaryInductionVariable()->usesUnchangedValueInLoopTest())
{
//getLoopStride is +/- depending on the direction of the loop
//
int32_t incrVal = getLoopStride();
// always use add for addresses, so the stride needs to be negated
// because we're using sub below
//
bool isAddress = getIndexType().isAddress();
if (isAddress)
incrVal = -incrVal;
TR::ILOpCodes subOp;
TR::Node *constNode = NULL;
if (is64BitComparison)
{
subOp = isAddress ? TR::aladd : TR::lsub;
constNode = TR::Node::lconst(newLimitNode, (int64_t) incrVal);
}
else
{
subOp = isAddress ? TR::aiadd : TR::isub;
constNode = TR::Node::iconst(newLimitNode, incrVal);
}
dupNewLimit = TR::Node::create(subOp, 2, dupNewLimit, constNode);
}
TR::TreeTop *iterGuard =
TR::TreeTop::create(comp(),
TR::Node::createif(opCode, firstChild, dupNewLimit, spillBlock->getEntry()));
if (lastTree->getNode()->getOpCodeValue() != TR::Goto)
{
// append an if block to the loop invariant block
//
TR::Block *newBlock = TR::Block::createEmptyBlock(lastTree->getNode(), comp(), pBlock->getFrequency(), pBlock);
newBlock->append(iterGuard);
TR::Block *nextBlock = pBlock->getNextBlock();
newBlock->getExit()->join(nextBlock->getEntry());
pBlock->getExit()->join(newBlock->getEntry());
_cfg->addNode(newBlock);
TR_BlockStructure *newBlockStructure = new (_cfg->structureMemoryRegion()) TR_BlockStructure(comp(), newBlock->getNumber(), newBlock);
TR_StructureSubGraphNode *newSubNode = new (_cfg->structureMemoryRegion()) TR_StructureSubGraphNode(newBlockStructure);
parent->addSubNode(newSubNode);
TR::CFGEdge *edgeToRemove = NULL;
for (auto edge = pBlock->getSuccessors().begin(); edge != pBlock->getSuccessors().end(); ++edge)
{
if ((*edge)->getTo()->getNumber() != spillBlock->getNumber())
{
edgeToRemove = *edge;
break;
}
}
_cfg->addEdge(TR::CFGEdge::createEdge(pBlock, newBlock, trMemory()));
TR::CFGEdge::createEdge(predNode, newSubNode, trMemory());
_cfg->addEdge(TR::CFGEdge::createEdge(newBlock, spillBlock, trMemory()));
TR::CFGEdge::createEdge(newSubNode, _spillNode, trMemory());
_cfg->addEdge(TR::CFGEdge::createEdge(newBlock, nextBlock, trMemory()));
TR::CFGEdge::createEdge(newSubNode, parent->findSubNodeInRegion(nextBlock->getNumber()), trMemory());
_cfg->removeEdge(edgeToRemove);
parent->removeEdge(predBlock, parent->findSubNodeInRegion(nextBlock->getNumber())->getStructure());
_loopIterTestBlock = newBlock;
}
else
{
// loop invariant block ends with a goto
// create a new block - move the goto in the new block and add append an if to the loop inv block
//
TR::Block *newBlock = pBlock->split(lastTree, _cfg);
pBlock->append(iterGuard);
TR_BlockStructure *newBlockStructure = new (_cfg->structureMemoryRegion()) TR_BlockStructure(comp(), newBlock->getNumber(), newBlock);
TR_StructureSubGraphNode *newSubNode = new (_cfg->structureMemoryRegion()) TR_StructureSubGraphNode(newBlockStructure);
parent->addSubNode(newSubNode);
_cfg->addEdge(TR::CFGEdge::createEdge(pBlock, spillBlock, trMemory()));
TR::CFGEdge::createEdge(predNode, _spillNode, trMemory());
// TR::Block::split does not know how to fix the structure edges, so do that ourselves
TR::CFGEdge::createEdge(predNode, newSubNode, trMemory());
TR::CFGEdge::createEdge(newSubNode, loopNode, trMemory());
parent->removeEdge(predBlock, loop);
_loopIterTestBlock = pBlock;
}
if (trace())
{
comp()->dumpMethodTrees("\nafter adding loopiter test");
getDebug()->print(comp()->getOutFile(), _rootStructure, 6);
}
}
}
// if an internalpointer is going to be created, ensure it
// does not exceed the limits
bool TR_LoopUnroller::isInternalPointerLimitExceeded()
{
return _spillLoopRequired && isCountedLoop() && getIndexType().isAddress() &&
comp()->getSymRefTab()->getNumInternalPointers() >= comp()->maxInternalPointers();
}
void TR_LoopUnroller::modifyOriginalLoop(TR_RegionStructure *loop, TR_StructureSubGraphNode *branchNode)
{
int32_t origExitNum = 0;
if (1)
{
ListIterator<TR::CFGEdge> it(&loop->getExitEdges());
for (TR::CFGEdge *edge = it.getFirst(); edge; edge = it.getNext())
{
if (edge->getFrom()->asStructureSubGraphNode() == branchNode)
{
origExitNum = edge->getTo()->getNumber();
break;
}
}
}
if (!isCountedLoop())
{
TR_ASSERT(_unrollKind != CompleteUnroll, "Non induction loops cannot be unrolled completely");
TR_ASSERT(_spillLoopRequired == false, "Non induction loops must be unrolled without a spill loop");
}
TR::CFGEdge *edge;
//Redirect all the local predecessors of the entry to the 'firstEntryNode'
for (auto edge = loop->getEntry()->getPredecessors().begin(); edge != loop->getEntry()->getPredecessors().end();)
{
TR::CFGEdge* current = *(edge++);
if (!loop->isExitEdge(current))
{
TR_StructureSubGraphNode *predNode = toStructureSubGraphNode(current->getFrom());
if (predNode->getNumber() < _numNodes)
{
if (shouldConnectToNextIteration(predNode, loop))
{
addEdgeAndFixEverything(loop, current, predNode, _firstEntryNode, true, true, true, BackEdgeFromPrevGeneration);
loop->removeEdge(predNode->getStructure(), loop->getEntry()->getStructure());
}
else
{
if (trace())
traceMsg(comp(), "Redirecting cold edge from block_%d to unrolled loop header rather than going to the next iteration\n", predNode->getNumber());
addEdgeAndFixEverything(loop, current, predNode, loop->getEntry(), true, false, true, BackEdgeToEntry);
}
}
}
}
//Find the node corresponding to loop
TR_RegionStructure *parent = loop->getParent()->asRegion();
TR_RegionStructure::Cursor nodeIt(*parent);
TR_StructureSubGraphNode *loopNode = NULL;
for (TR_StructureSubGraphNode *node = nodeIt.getFirst(); node; node = nodeIt.getNext())
if (node->getStructure() == loop)
{
loopNode = node;
break;
}
TR_ASSERT(loopNode != NULL, "loopNode not found\n");
TR::Block *branchBlock = branchNode->getStructure()->asBlock()->getBlock();
TR::Node *branch = branchBlock->getLastRealTreeTop()->getNode();
// find the insertion point of the unrolled bodies
//
TR::TreeTop *oldLoopEntryTree = NULL; //loop->getEntryBlock()->getEntry();
if (_unrollKind == SPMDKernel)
{
if (_spillLoopRequired)
modifyBranchTree(loop, loopNode, branchNode);
}
else
if (isCountedLoop() && _unrollKind != CompleteUnroll) /*GGLU*/
{
//The branch condition is modified if there is going to be a spill loop.
if (_spillLoopRequired)
{
modifyBranchTree(loop, loopNode, branchNode);
}
// IVA does not create PIV for ifacmpne and ifacmpeq, thus loops with ifacmpne are not counted loop
// and they won't enter this if so there is no need to check for ifacmpne
TR_ASSERT(branch->getOpCodeValue() != TR::ifacmpeq && branch->getOpCodeValue() != TR::ifacmpne, "Counted loop with branch node %p of opcode %s is unexpected\n", branch, branch->getOpCode().getName());
//convert the != condition to a '<' or '>' condition.
if (branch->getOpCodeValue() == TR::ificmpne)
{
if (isIncreasingLoop())
TR::Node::recreate(branch, TR::ificmplt);
else
TR::Node::recreate(branch, TR::ificmpgt);
}
else if (branch->getOpCodeValue() == TR::iflcmpne)
{
if (isIncreasingLoop())
TR::Node::recreate(branch, TR::iflcmplt);
else
TR::Node::recreate(branch, TR::iflcmpgt);
}
}
else if (_unrollKind == CompleteUnroll) /*GGLU*/
{
//Complete Unroll. Remove the branch
//
TR::Block *destBlock = branch->getBranchDestination()->getNode()->getBlock();
TR_Structure *destStruct = destBlock->getStructureOf();
if (loop->contains(destStruct, loop->getParent()))
{
TR::Node *gotoNode = TR::Node::create(branch, TR::Goto);
TR::TreeTop *gotoTree = TR::TreeTop::create(comp(), gotoNode);
gotoNode->setBranchDestination(destBlock->getEntry());
gotoNode->setLocalIndex(CREATED_BY_GLU);
TR::TransformUtil::removeTree(comp(), branchBlock->getLastRealTreeTop());
branchBlock->append(gotoTree);
oldLoopEntryTree = branchBlock->getExit()->getNextTreeTop();
//Find exitNode X.
//
TR::CFGNode *exitNode = NULL;
for (auto edge = branchNode->getSuccessors().begin(); (edge != branchNode->getSuccessors().end()) && exitNode == NULL; ++edge)
{
if (loop->isExitEdge(*edge))
exitNode = (*edge)->getTo();
}
//Remove B->X*
//
removeExternalEdge(loop, branchNode, exitNode->getNumber());
TR_StructureSubGraphNode *concreteExitNode =
findNodeInHierarchy(loop->getParent()->asRegion(), exitNode->getNumber());
TR::Block *blockX = getEntryBlockNode(concreteExitNode)
->getStructure()->asBlock()->getBlock();
_cfg->removeEdge(branchBlock, blockX);
}
else
{
// FIXME: this is wrong (unreachable because of hack in heuristic)
//
// remove B->X*, replace the branch with a goto to the first entry node
// create edges for B->F
//
TR_ASSERT(0, "should not reach here");
branchBlock->removeBranch(comp());
}
}
//FIXME: we can improve the following a bit
// if (isCountedLoop && !_completeUnroll && !_spillLoopRequired)
// {
// //Adjust the induction variable information to include the new information
// _indVar->setIncr(new (trHeapMemory()) TR::VPIntConst(_loopStride * (1 + _unrollCount)));
// }
// else