/
ControlFlowEvaluator.cpp
3234 lines (2807 loc) · 118 KB
/
ControlFlowEvaluator.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 (c) 2000, 2019 IBM Corp. and others
*
* 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 http://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] http://openjdk.java.net/legal/assembly-exception.html
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
*******************************************************************************/
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include "codegen/CodeGenerator.hpp"
#include "codegen/FrontEnd.hpp"
#include "codegen/InstOpCode.hpp"
#include "codegen/Instruction.hpp"
#include "codegen/Linkage.hpp"
#include "codegen/Linkage_inlines.hpp"
#include "codegen/Machine.hpp"
#include "codegen/MemoryReference.hpp"
#include "codegen/RealRegister.hpp"
#include "codegen/RecognizedMethods.hpp"
#include "codegen/Register.hpp"
#include "codegen/RegisterDependency.hpp"
#include "codegen/RegisterPair.hpp"
#include "codegen/TreeEvaluator.hpp"
#include "codegen/S390Evaluator.hpp"
#include "compile/Compilation.hpp"
#include "compile/Method.hpp"
#include "compile/ResolvedMethod.hpp"
#include "compile/SymbolReferenceTable.hpp"
#include "compile/VirtualGuard.hpp"
#include "control/Options.hpp"
#include "control/Options_inlines.hpp"
#include "env/CompilerEnv.hpp"
#ifdef J9_PROJECT_SPECIFIC
#include "env/CHTable.hpp"
#endif
#include "env/TRMemory.hpp"
#include "env/jittypes.h"
#include "il/Block.hpp"
#include "il/DataTypes.hpp"
#include "il/ILOpCodes.hpp"
#include "il/ILOps.hpp"
#include "il/Node.hpp"
#include "il/Node_inlines.hpp"
#include "il/Symbol.hpp"
#include "il/SymbolReference.hpp"
#include "il/TreeTop.hpp"
#include "il/TreeTop_inlines.hpp"
#include "il/symbol/AutomaticSymbol.hpp"
#include "il/symbol/LabelSymbol.hpp"
#include "il/symbol/MethodSymbol.hpp"
#include "il/symbol/ResolvedMethodSymbol.hpp"
#include "infra/Assert.hpp"
#include "infra/Bit.hpp"
#include "infra/BitVector.hpp"
#include "infra/List.hpp"
#include "ras/Debug.hpp"
#include "ras/Delimiter.hpp"
#include "z/codegen/BinaryAnalyser.hpp"
#include "z/codegen/BinaryCommutativeAnalyser.hpp"
#include "z/codegen/CompareAnalyser.hpp"
#include "z/codegen/S390GenerateInstructions.hpp"
#include "z/codegen/S390HelperCallSnippet.hpp"
#include "z/codegen/S390Instruction.hpp"
#include "z/codegen/S390OutOfLineCodeSection.hpp"
#ifdef J9_PROJECT_SPECIFIC
#include "z/codegen/S390Register.hpp"
#endif
#include "z/codegen/TranslateEvaluator.hpp"
extern TR::Instruction *
generateS390PackedCompareAndBranchOps(TR::Node * node,
TR::CodeGenerator * cg,
TR::InstOpCode::S390BranchCondition fBranchOpCond,
TR::InstOpCode::S390BranchCondition rBranchOpCond,
TR::InstOpCode::S390BranchCondition &retBranchOpCond,
TR::LabelSymbol *branchTarget = NULL);
extern TR::Register *
iDivRemGenericEvaluator(TR::Node * node, TR::CodeGenerator * cg, bool isDivision, TR::MemoryReference * divchkDivisorMR);
TR::InstOpCode::S390BranchCondition generateS390CompareOps(TR::Node * node, TR::CodeGenerator * cg, TR::InstOpCode::S390BranchCondition fBranchOpCond, TR::InstOpCode::S390BranchCondition rBranchOpCond);
TR::Instruction * generateS390CompareOps(TR::Node * node, TR::CodeGenerator * cg, TR::InstOpCode::S390BranchCondition fBranchOpCond, TR::InstOpCode::S390BranchCondition rBranchOpCond, TR::LabelSymbol *branchTarget);
void killRegisterIfNotLocked(TR::CodeGenerator * cg, TR::RealRegister::RegNum reg, TR::Instruction * instr , TR::RegisterDependencyConditions * deps = NULL)
{
TR::Register *dummy = NULL;
if (cg->machine()->getRealRegister(reg)->getState() != TR::RealRegister::Locked)
{
if (deps == NULL)
deps = new (cg->trHeapMemory()) TR::RegisterDependencyConditions(0, 1, cg);
dummy = cg->allocateRegister();
deps->addPostCondition(dummy, TR::RealRegister::GPR4);
dummy->setPlaceholderReg();
instr->setDependencyConditions(deps);
cg->stopUsingRegister(dummy);
}
}
/**
* Helper to generate virtual guard if node is so flagged. In 32 bit mode the NOP instruction,
* a BRC, has only a +ve displacement of 2^12 (4k), and so in some cases it is not safe to use it
* on a G5 platform (no problems with BRCL). At this point, since instructions have not yet
* been generated, there is no good way to guage how far away the label will be, so we cannot
* even determine if it is safe. Will never be enabled for G5 hardware
* Note that some instructions *must* have a virtual guard generated for them.
*/
static bool
virtualGuardHelper(TR::Node * node, TR::CodeGenerator * cg)
{
#ifdef J9_PROJECT_SPECIFIC
TR::Compilation *comp = cg->comp();
if ((!node->isNopableInlineGuard() && !node->isHCRGuard() && !node->isOSRGuard()) ||
!cg->getSupportsVirtualGuardNOPing())
{
return false;
}
TR_VirtualGuard * virtualGuard = comp->findVirtualGuardInfo(node);
if (!node->isHCRGuard() && !node->isOSRGuard() && !(comp->performVirtualGuardNOPing() &&
comp->isVirtualGuardNOPingRequired(virtualGuard)) &&
virtualGuard->canBeRemoved())
{
return false;
}
if (node->getOpCodeValue() != TR::ificmpne && node->getOpCodeValue() != TR::iflcmpne && node->getOpCodeValue() != TR::ifacmpne)
{
//TR_ASSERT( 0, "virtualGuardHelper: not expecting reversed comparison");
return false;
}
TR_VirtualGuardSite * site = NULL;
if (comp->compileRelocatableCode())
{
site = (TR_VirtualGuardSite *)comp->addAOTNOPSite();
TR_AOTGuardSite *aotSite = (TR_AOTGuardSite *)site;
aotSite->setType(virtualGuard->getKind());
aotSite->setNode(node);
switch (virtualGuard->getKind())
{
case TR_DirectMethodGuard:
case TR_NonoverriddenGuard:
case TR_InterfaceGuard:
case TR_MethodEnterExitGuard:
case TR_HCRGuard:
case TR_AbstractGuard:
aotSite->setGuard(virtualGuard);
break;
case TR_ProfiledGuard:
break;
default:
TR_ASSERT_FATAL(0, "got AOT guard in node but virtual guard not one of known guards supported for AOT. Guard: %d", virtualGuard->getKind());
break;
}
}
else if (!node->isSideEffectGuard())
{
TR_VirtualGuard * virtualGuard = comp->findVirtualGuardInfo(node);
site = virtualGuard->addNOPSite();
}
else
{
site = comp->addSideEffectNOPSite();
}
TR::RegisterDependencyConditions * deps;
if (node->getNumChildren() == 3)
{
TR::Node * third = node->getChild(2);
cg->evaluate(third);
deps = generateRegisterDependencyConditions(cg, third, 0);
}
else
{
deps = new (cg->trHeapMemory()) TR::RegisterDependencyConditions((uint16_t) 0, (uint16_t) 0, cg);
}
if(virtualGuard->shouldGenerateChildrenCode())
cg->evaluateChildrenWithMultipleRefCount(node);
generateVirtualGuardNOPInstruction(cg, node, site, deps, node->getBranchDestination()->getNode()->getLabel());
cg->recursivelyDecReferenceCount(node->getFirstChild());
cg->recursivelyDecReferenceCount(node->getSecondChild());
traceMsg(comp, "virtualGuardHelper for %s %s\n",
comp->getDebug()?comp->getDebug()->getVirtualGuardKindName(virtualGuard->getKind()):"???Guard" , virtualGuard->mergedWithHCRGuard()?"merged with HCRGuard":"");
return true;
#else
return false;
#endif
}
//////////////////////////////////////////////////////////////////////////////////////////////////
// Long Compare Helper code
//
#define CMP4BOOLEAN true
#define CMP4CONTROLFLOW false
static TR::Register *
generateS390lcmpEvaluator64(TR::Node * node, TR::CodeGenerator * cg, TR::InstOpCode::Mnemonic brOp, TR::InstOpCode::S390BranchCondition brCond, bool isBoolean)
{
TR::RegisterDependencyConditions * deps = NULL;
TR::LabelSymbol * cFlowRegionStart = generateLabelSymbol(cg);
TR::LabelSymbol * isTrue = generateLabelSymbol(cg);
bool isUnsigned = node->getOpCode().isUnsignedCompare();
TR::Register * targetRegister = cg->allocateRegister();
TR::Node * firstChild = node->getFirstChild();
TR_ASSERT(isBoolean, "Coparison node %p is not boolean\n",node);
// Assume the condition is true.
genLoadLongConstant(cg, node, 1, targetRegister);
TR::Node * secondChild = node->getSecondChild();
if (secondChild->getOpCode().isLoadConst() && secondChild->getRegister() == NULL)
{
deps = new (cg->trHeapMemory()) TR::RegisterDependencyConditions(0, 1, cg);
int64_t long_value = secondChild->getLongInt();
TR::Register * cmpRegister = cg->evaluate(firstChild);
generateS390ImmOp(cg, isUnsigned ? TR::InstOpCode::CLG : TR::InstOpCode::CG, node, cmpRegister, cmpRegister, long_value);
generateS390LabelInstruction(cg, TR::InstOpCode::LABEL, node, cFlowRegionStart);
generateS390BranchInstruction(cg, brOp, brCond, node, isTrue);
}
else
{
// We should use the Binary analyzer here
TR::Node * firstChild = node->getFirstChild();
TR::Register * cmpRegister = cg->evaluate(firstChild);
TR::Register * srcReg = cg->evaluate(secondChild);
deps = new (cg->trHeapMemory()) TR::RegisterDependencyConditions(0, 3, cg);
deps->addPostConditionIfNotAlreadyInserted(cmpRegister,TR::RealRegister::AssignAny);
deps->addPostConditionIfNotAlreadyInserted(srcReg,TR::RealRegister::AssignAny);
generateS390LabelInstruction(cg, TR::InstOpCode::LABEL, node, cFlowRegionStart);
generateS390CompareAndBranchInstruction(cg, isUnsigned ? TR::InstOpCode::CLGR : TR::InstOpCode::CGR, node, cmpRegister, srcReg, brCond, isTrue, false, false);
}
cFlowRegionStart->setStartInternalControlFlow();
deps->addPostConditionIfNotAlreadyInserted(targetRegister,TR::RealRegister::AssignAny);
// FALSE
genLoadLongConstant(cg, node, 0, targetRegister);
// TRUE
generateS390LabelInstruction(cg, TR::InstOpCode::LABEL, node, isTrue, deps);
isTrue->setEndInternalControlFlow();
node->setRegister(targetRegister);
cg->decReferenceCount(firstChild);
cg->decReferenceCount(secondChild);
return targetRegister;
}
/**
* Generate code to perform a comparison that returns 1 , -1, or 0
* Handles TR::fcmpl, TR::fcmpg, TR::dcmpl, and TR::dcmpg
*/
TR::Register *
OMR::Z::TreeEvaluator::fcmplEvaluator(TR::Node * node, TR::CodeGenerator * cg)
{
TR::InstOpCode::Mnemonic branchOp;
TR::InstOpCode::S390BranchCondition brCond ;
// Create ICF start label
TR::LabelSymbol * cFlowRegionStart = generateLabelSymbol(cg);
// Create a label
TR::LabelSymbol * cFlowRegionEnd = generateLabelSymbol(cg);
// Create a register
TR::Register * targetRegister = cg->allocateRegister();
// Generate compare code, find out if ops were reversed
brCond = generateS390CompareOps(node, cg, TR::InstOpCode::COND_BH, TR::InstOpCode::COND_BL);
branchOp = TR::InstOpCode::BRC;
// Assume A == B, set targetRegister value to 0
// TODO: Can we allow setting the condition code here by moving the load before the compare?
generateLoad32BitConstant(cg, node, 0, targetRegister, false);
// done if A==B
TR::RegisterDependencyConditions *deps = new (cg->trHeapMemory()) TR::RegisterDependencyConditions(0, 1, cg);
deps->addPostCondition(targetRegister,TR::RealRegister::AssignAny);
generateS390LabelInstruction(cg, TR::InstOpCode::LABEL, node, cFlowRegionStart);
cFlowRegionStart->setStartInternalControlFlow();
generateS390BranchInstruction(cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_BE, node, cFlowRegionEnd);
// Found A != B, assume A > B, set targetRegister value to 1
generateLoad32BitConstant(cg, node, 1, targetRegister, false);
//done if A>B
generateS390BranchInstruction(cg, branchOp, brCond, node, cFlowRegionEnd);
//found either A<B or either of A and B is NaN
//For TR::fcmpg instruction, done if either of A and B is NaN
if (node->getOpCodeValue() == TR::fcmpg || node->getOpCodeValue() == TR::dcmpg)
{
generateS390BranchInstruction(cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_MASK1, node, cFlowRegionEnd);
}
//Got here? means either A<B or (TR::fcmpl instruction and (A==NaN || B==NaN))
//set targetRegister value to -1
generateLoad32BitConstant(cg, node, -1, targetRegister, true);
// DONE
generateS390LabelInstruction(cg, TR::InstOpCode::LABEL, node, cFlowRegionEnd, deps);
cFlowRegionEnd->setEndInternalControlFlow();
node->setRegister(targetRegister);
return targetRegister;
}
inline TR::InstOpCode::S390BranchCondition
generateS390Compare(TR::Node * node, TR::CodeGenerator * cg, TR::InstOpCode::Mnemonic branchOp, TR::InstOpCode::S390BranchCondition fBranchOpCond, TR::InstOpCode::S390BranchCondition rBranchOpCond)
{
// Generate compare code, find out if ops were reversed
TR::InstOpCode::S390BranchCondition branchOpCond = generateS390CompareOps(node, cg, fBranchOpCond, rBranchOpCond);
return branchOpCond;
}
/**
* \brief
* Compares 2 numbers are returns the greater of the 2.
* ONLY SUPPORTS imax, imin, lmax, lmin
*
* \detail
* Uses a load and conditional store to select the correct value.
* ONLY SUPPORTS imax, imin, lmax, lmin
*
* \param node
* The node representing a call to max or min.
*
* \param cg
* The code generator used to generate the instructions.
*
* \param isMax
* Boolean representing the type of function, either a max or min call.
*
* \return
* A register containing the return value of the Java call. The return value
* will be the greater or lesser of the 2 children for max and min functions, respectively.
*/
static TR::Register * maxMinHelper(TR::Node *node, TR::CodeGenerator *cg, bool isMax)
{
TR_ASSERT_FATAL(TR::Compiler->target.cpu.getSupportsArch(TR::CPU::TR_z196),
"cannot evaluate %s on z10 or below", node->getOpCode().getName());
TR::Register *registerA;
TR::Register *registerB = cg->evaluate(node->getSecondChild());
// Mask is 4 to pick b when a is Lower for max, 2 to pick b when a is higher for min
const uint8_t mask = isMax ? 0x4 : 0x2;
if (node->getOpCodeValue() == TR::imax || node->getOpCodeValue() == TR::imin)
{
if (TR::Compiler->target.cpu.getSupportsArch(TR::CPU::TR_z15))
{
registerA = cg->allocateRegister();
// Load into a tmp instead of clobberEvaluating into registerA to avoid an extra register shuffle
TR::Register* tmpRegister = cg->evaluate(node->getFirstChild());
generateRRInstruction(cg, TR::InstOpCode::CR, node, tmpRegister, registerB);
generateRRFInstruction(cg, TR::InstOpCode::SELR, node, registerA, registerB, tmpRegister, mask);
}
else
{
registerA = cg->gprClobberEvaluate(node->getFirstChild());
generateRRInstruction(cg, TR::InstOpCode::CR, node, registerA, registerB);
generateRRFInstruction(cg, TR::InstOpCode::LOCR, node, registerA, registerB, mask, true);
}
}
else if (node->getOpCodeValue() == TR::lmax || node->getOpCodeValue() == TR::lmin)
{
if (TR::Compiler->target.cpu.getSupportsArch(TR::CPU::TR_z15))
{
registerA = cg->allocateRegister();
// Load into a tmp instead of clobberEvaluating into registerA to avoid an extra register shuffle
TR::Register* tmpRegister = cg->evaluate(node->getFirstChild());
generateRREInstruction(cg, TR::InstOpCode::CGR, node, tmpRegister, registerB);
generateRRFInstruction(cg, TR::InstOpCode::SELGR, node, registerA, registerB, tmpRegister, mask);
}
else
{
registerA = cg->gprClobberEvaluate(node->getFirstChild());
generateRREInstruction(cg, TR::InstOpCode::CGR, node, registerA, registerB);
generateRRFInstruction(cg, TR::InstOpCode::LOCGR, node, registerA, registerB, mask, true);
}
}
else
{
TR_ASSERT_FATAL(node->getOpCodeValue(), "Opcode %s cannot be evaluated by maxMinHelper\n", node->getOpCode().getName());
}
node->setRegister(registerA);
cg->decReferenceCount(node->getFirstChild());
cg->decReferenceCount(node->getSecondChild());
return registerA;
}
TR::Register *
OMR::Z::TreeEvaluator::maxEvaluator(TR::Node *node, TR::CodeGenerator *cg)
{
return maxMinHelper(node, cg, true);
}
TR::Register *
OMR::Z::TreeEvaluator::minEvaluator(TR::Node *node, TR::CodeGenerator *cg)
{
return maxMinHelper(node, cg, false);
}
/**
* 64bit version lcmpEvaluator Helper: long compare (1 if child1 > child2, 0 if child1 == child2,
* -1 if child1 < child2 or unordered)
*/
TR::Register *
lcmpHelper64(TR::Node * node, TR::CodeGenerator * cg)
{
// TODO:There is probably a better way to implement this. Should re-visit if we get the chance.
// As things stand now, we will to LCR R1,R1 when R1=0 which is useless... But still probably
// cheaper than an extra branch.
TR::LabelSymbol * cFlowRegionStart = generateLabelSymbol(cg);
TR::LabelSymbol * labelGT = generateLabelSymbol(cg);
TR::LabelSymbol * labelLT = generateLabelSymbol(cg);
TR::Register * targetRegister = cg->allocateRegister();
TR::Node * firstChild = node->getFirstChild();
TR::Node * secondChild = node->getSecondChild();
TR::Register * src1Reg = NULL;
if (firstChild->getReferenceCount() == 1)
src1Reg = (TR::Register *) cg->evaluate(firstChild);
else
src1Reg = (TR::Register *) cg->gprClobberEvaluate(firstChild);
TR::Register * src2Reg = NULL;
TR::Instruction * cursor = NULL;
if (secondChild->getOpCode().isLoadConst() && secondChild->getLongInt()==0)
{
generateRRInstruction(cg, TR::InstOpCode::LCGR, node, targetRegister, src1Reg);
generateRSInstruction(cg, TR::InstOpCode::SRAG, node, src1Reg, src1Reg, 63);
generateRSInstruction(cg, TR::InstOpCode::SRLG, node, targetRegister, targetRegister, 63);
generateRRInstruction(cg, TR::InstOpCode::OGR, node, targetRegister, src1Reg);
}
else
{
// Assume LT
generateRIInstruction(cg, TR::InstOpCode::LGHI, node, targetRegister, -1);
if (secondChild->getOpCode().isLoadConst() && secondChild->getRegister() == NULL)
{
// Set the CC using a comp.
generateS390ImmOp(cg, TR::InstOpCode::CG, node, src1Reg, src1Reg, secondChild->getLongInt());
}
else
{
// Get src2Reg if it isn't a const
src2Reg = cg->evaluate(secondChild);
// Set the CC using a comp.
generateRRInstruction(cg, TR::InstOpCode::CGR, node, src1Reg, src2Reg);
}
// If LT we are done
generateS390LabelInstruction(cg, TR::InstOpCode::LABEL, node, cFlowRegionStart);
cFlowRegionStart->setStartInternalControlFlow();
generateS390BranchInstruction(cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_BL, node, labelLT);
// If GT, we invert the result register
generateS390BranchInstruction(cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_BH, node, labelGT);
// High order words were equal
// The two longs are equal
generateRIInstruction(cg, TR::InstOpCode::LGHI, node, targetRegister, 0);
// We can go through this path if GT, or if EQ.
// We use LCR to avoid having to branch over this piece of code.
generateS390LabelInstruction(cg, TR::InstOpCode::LABEL, node, labelGT);
generateRRInstruction(cg, TR::InstOpCode::LCGR, node, targetRegister, targetRegister);
// We branch here when LT (no change to assumed -1 result)
TR::RegisterDependencyConditions * dependencies = NULL;
dependencies = new (cg->trHeapMemory()) TR::RegisterDependencyConditions(0, 1, cg);
dependencies->addPostCondition(targetRegister, TR::RealRegister::AssignAny);
generateS390LabelInstruction(cg, TR::InstOpCode::LABEL, node, labelLT, dependencies);
labelLT->setEndInternalControlFlow();
}
node->setRegister(targetRegister);
// did we clobberEval earlier?
if (!cg->canClobberNodesRegister(firstChild))
cg->stopUsingRegister(src1Reg);
cg->decReferenceCount(firstChild);
cg->decReferenceCount(secondChild);
return targetRegister;
}
TR::Register *
OMR::Z::TreeEvaluator::branchEvaluator(TR::Node * node, TR::CodeGenerator *cg)
{
return NULL;
}
TR::Register *
OMR::Z::TreeEvaluator::ibranchEvaluator(TR::Node * node, TR::CodeGenerator *cg)
{
return NULL;
}
TR::Register *
OMR::Z::TreeEvaluator::mbranchEvaluator(TR::Node * node, TR::CodeGenerator *cg)
{
return NULL;
}
/**
* goto label address
*/
TR::Register *
OMR::Z::TreeEvaluator::gotoEvaluator(TR::Node * node, TR::CodeGenerator * cg)
{
TR::Node * temp = node->getBranchDestination()->getNode();
if (node->getNumChildren() > 0)
{
// GRA
TR::Node * child = node->getFirstChild();
cg->evaluate(child);
generateS390BranchInstruction(cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_BRC, node, temp->getLabel(), generateRegisterDependencyConditions(cg, child, 0));
cg->decReferenceCount(child);
}
else
{
generateS390BranchInstruction(cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_BRC, node, temp->getLabel());
}
return NULL;
}
/**
* Indirect goto to the address
*/
TR::Register *
OMR::Z::TreeEvaluator::igotoEvaluator(TR::Node * node, TR::CodeGenerator * cg)
{
TR_ASSERT( node->getNumChildren() >= 1, "at least one child expected for igoto");
TR::Node * child = node->getFirstChild();
TR::Register * dest = cg->evaluate(child);
TR::RegisterDependencyConditions * deps = NULL;
if (node->getNumChildren() > 1)
{
TR_ASSERT( node->getNumChildren() == 2 && node->getChild(1)->getOpCodeValue() == TR::GlRegDeps, "igoto has maximum of two children and second one must be global register dependency");
TR::Node *glregdep = node->getChild(1);
cg->evaluate(glregdep);
deps = generateRegisterDependencyConditions(cg, glregdep, 0);
cg->decReferenceCount(glregdep);
}
TR::Instruction* cursor;
if (deps)
cursor = generateS390RegInstruction(cg, TR::InstOpCode::BCR, node, dest, deps);
else
cursor = generateS390RegInstruction(cg, TR::InstOpCode::BCR, node, dest);
((TR::S390RegInstruction *)cursor)->setBranchCondition(TR::InstOpCode::COND_BCR);
cg->decReferenceCount(child);
return NULL;
}
/**
* Handles all types of return opcodes
* (return, areturn, ireturn, lreturn, freturn, dreturn, iureturn, lureturn, oreturn)
*/
TR::Register *
OMR::Z::TreeEvaluator::returnEvaluator(TR::Node * node, TR::CodeGenerator * cg)
{
TR::Compilation *comp = cg->comp();
if ((node->getOpCodeValue() == TR::Return) && node->isReturnDummy()) return NULL;
TR::Register * returnAddressReg = cg->allocateRegister();
TR::Register * returnValRegister = NULL;
TR::Register * CAARegister = NULL;
TR::Linkage * linkage = cg->getS390Linkage();
if (node->getOpCodeValue() != TR::Return)
returnValRegister = cg->evaluate(node->getFirstChild());
// add register dependency for the return value register and the return register
TR::RegisterDependencyConditions * dependencies = NULL ;
if (node->getOpCode().isJumpWithMultipleTargets() &&
(node->getNumChildren() > 1
) && node->getChild(node->getNumChildren() - 1)->getOpCodeValue() == TR::GlRegDeps)
{
TR::Node *glregdep = node->getChild(node->getNumChildren() - 1);
cg->evaluate(glregdep);
dependencies = generateRegisterDependencyConditions(cg, glregdep, 3);
cg->decReferenceCount(glregdep);
}
dependencies= new (cg->trHeapMemory()) TR::RegisterDependencyConditions(0, 3, cg);
#ifdef J9_PROJECT_SPECIFIC
if ( node->getOpCodeValue() == TR::dereturn )
dependencies= new (cg->trHeapMemory()) TR::RegisterDependencyConditions(0, 4, cg);
#endif
int regDepChildNum = 1;
switch (node->getOpCodeValue())
{
case TR::areturn:
comp->setReturnInfo(TR_ObjectReturn);
dependencies->addPostCondition(returnValRegister, linkage->getIntegerReturnRegister());
break;
case TR::ireturn:
dependencies->addPostCondition(returnValRegister, linkage->getIntegerReturnRegister());
comp->setReturnInfo(TR_IntReturn);
if (linkage->isNeedsWidening())
new (cg->trHeapMemory()) TR::S390RRInstruction(TR::InstOpCode::LGFR, node, returnValRegister, returnValRegister, cg);
break;
case TR::iureturn:
comp->setReturnInfo(TR_IntReturn);
dependencies->addPostCondition(returnValRegister, linkage->getIntegerReturnRegister());
if (linkage->isNeedsWidening())
new (cg->trHeapMemory()) TR::S390RRInstruction(TR::InstOpCode::LLGFR, node, returnValRegister, returnValRegister, cg);
break;
case TR::lreturn:
case TR::lureturn:
comp->setReturnInfo(TR_LongReturn);
if (TR::Compiler->target.is64Bit())
{
dependencies->addPostCondition(returnValRegister, linkage->getLongReturnRegister());
}
else
{
TR::Register * highRegister = cg->allocateRegister();
generateRSInstruction(cg, TR::InstOpCode::SRLG, node, highRegister, returnValRegister, 32);
dependencies->addPostCondition(returnValRegister, linkage->getLongLowReturnRegister());
dependencies->addPostCondition(highRegister, linkage->getLongHighReturnRegister());
cg->stopUsingRegister(highRegister);
}
break;
case TR::freturn:
#ifdef J9_PROJECT_SPECIFIC
case TR::dfreturn:
#endif
comp->setReturnInfo(TR_FloatReturn);
dependencies->addPostCondition(returnValRegister, linkage->getFloatReturnRegister());
break;
case TR::dreturn:
#ifdef J9_PROJECT_SPECIFIC
case TR::ddreturn:
#endif
comp->setReturnInfo(TR_DoubleReturn);
dependencies->addPostCondition(returnValRegister, linkage->getDoubleReturnRegister());
break;
#ifdef J9_PROJECT_SPECIFIC
case TR::dereturn:
comp->setReturnInfo(TR_DoubleReturn);
dependencies->addPostCondition(returnValRegister->getHighOrder(), linkage->getLongDoubleReturnRegister0());
dependencies->addPostCondition(returnValRegister->getLowOrder(), linkage->getLongDoubleReturnRegister2());
break;
#endif
case TR::Return:
comp->setReturnInfo(TR_VoidReturn);
break;
}
TR::Instruction * inst = generateS390PseudoInstruction(cg, TR::InstOpCode::RET, node, dependencies);
if (cg->supportsBranchPreload())
{
int32_t frequency = comp->getCurrentBlock()->getFrequency();
if (frequency >= cg->_hottestReturn._frequency)
{
cg->_hottestReturn._returnInstr = inst;
cg->_hottestReturn._frequency = frequency;
cg->_hottestReturn._returnBlock = comp->getCurrentBlock();
}
}
cg->stopUsingRegister(returnAddressReg);
if (node->getOpCodeValue() != TR::Return)
cg->decReferenceCount(node->getFirstChild());
return NULL;
}
bool OMR::Z::TreeEvaluator::isCandidateForButestEvaluation(TR::Node * node)
{
return node->getOpCode().isIf() &&
node->getFirstChild()->getOpCodeValue() == TR::butest &&
node->getFirstChild()->isSingleRefUnevaluated() &&
node->getSecondChild()->getOpCode().isLoadConst() &&
node->getSecondChild()->getType().isInt32();
}
bool OMR::Z::TreeEvaluator::isCandidateForCompareEvaluation(TR::Node * node)
{
return node->getOpCode().isIf() &&
TR::TreeEvaluator::isSingleRefUnevalAndCompareOrBu2iOverCompare(node->getFirstChild()) &&
node->getSecondChild()->getOpCode().isLoadConst() &&
node->getSecondChild()->getType().isInt32();
}
bool OMR::Z::TreeEvaluator::isSingleRefUnevalAndCompareOrBu2iOverCompare(TR::Node * node)
{
if (!node->isSingleRefUnevaluated())
return false;
if (node->getOpCodeValue() == TR::bu2i)
return TR::TreeEvaluator::isSingleRefUnevalAndCompareOrBu2iOverCompare(node->getFirstChild());
return false;
}
/**
* This helper is for generating a VGNOP for HCR or OSR guard when the guard it was merged with cannot be NOPed.
* 1. HCR or OSR guard is merged with ProfiledGuard
* 2. Any NOPable guards when node is switched from icmpne to icmpeq (can potentially happen during block reordering)
*
* When the condition is switched on node from eq to ne, HCR or OSR guard has to be patch to go to the fall through path
*/
static inline void generateMergedGuardCodeIfNeeded(TR::Node *node, TR::CodeGenerator *cg)
{
#ifdef J9_PROJECT_SPECIFIC
TR::Compilation *comp = cg->comp();
if (node->isTheVirtualGuardForAGuardedInlinedCall() && cg->getSupportsVirtualGuardNOPing())
{
TR_VirtualGuard *virtualGuard = comp->findVirtualGuardInfo(node);
if (virtualGuard && (virtualGuard->mergedWithOSRGuard() || virtualGuard->mergedWithHCRGuard()))
{
TR::RegisterDependencyConditions *mergedGuardDeps = NULL;
TR::Instruction *instr = cg->getAppendInstruction();
if (instr && instr->getNode() == node && instr->getDependencyConditions())
mergedGuardDeps = new (cg->trHeapMemory()) TR::RegisterDependencyConditions(instr->getDependencyConditions(), 1, 0, cg);
TR_VirtualGuardSite *site = virtualGuard->addNOPSite();
if (node->getOpCodeValue() == TR::ificmpeq ||
node->getOpCodeValue() == TR::ifiucmpeq ||
node->getOpCodeValue() == TR::ifacmpeq ||
node->getOpCodeValue() == TR::iflcmpeq )
{
TR::LabelSymbol *fallThroughLabel = generateLabelSymbol(cg);
TR::RegisterDependencyConditions *deps = new (cg->trHeapMemory()) TR::RegisterDependencyConditions((uint16_t) 0, (uint16_t) 0, cg);
TR::Instruction *vgnopInstr = generateVirtualGuardNOPInstruction(cg, node, site, deps, fallThroughLabel, instr ? instr->getPrev() : NULL);
vgnopInstr->setNext(instr);
cg->setAppendInstruction(instr);
generateS390LabelInstruction(cg, TR::InstOpCode::LABEL, node, fallThroughLabel, mergedGuardDeps);
}
else
{
TR::LabelSymbol *label = node->getBranchDestination()->getNode()->getLabel();
TR::Instruction *vgnopInstr = generateVirtualGuardNOPInstruction(cg, node, site, mergedGuardDeps, label, instr ? instr->getPrev() : NULL);
vgnopInstr->setNext(instr);
cg->setAppendInstruction(instr);
}
traceMsg(comp, "generateMergedGuardCodeIfNeeded for %s %s\n",
comp->getDebug()?comp->getDebug()->getVirtualGuardKindName(virtualGuard->getKind()):"???Guard" , virtualGuard->mergedWithHCRGuard()?"merged with HCRGuard": virtualGuard->mergedWithOSRGuard() ? "merged with OSRGuard" : "");
}
}
#endif
}
/**
* Integer compare and branch if equal
* - also handles ificmpne
* - handles ifacmpeq ifacmpne in 32bit mode
*/
TR::Register *
OMR::Z::TreeEvaluator::ificmpeqEvaluator(TR::Node * node, TR::CodeGenerator * cg)
{
TR::Compilation *comp = cg->comp();
if (virtualGuardHelper(node, cg))
{
return NULL;
}
if (TR::TreeEvaluator::isCandidateForButestEvaluation(node))
{
TR::Node * cmpNode = node;
TR::Node * butestNode = node->getFirstChild();
TR::Node * valueNode = node->getSecondChild();
return TR::TreeEvaluator::inlineIfButestEvaluator(butestNode, cg, cmpNode, valueNode);
}
if (TR::TreeEvaluator::isCandidateForCompareEvaluation(node))
{
TR::Node *ifNode = node;
TR::Node *cmpNode = node->getFirstChild();
if (cmpNode->getOpCodeValue() == TR::bu2i)
cmpNode = cmpNode->getFirstChild();
TR::Node *valueNode = node->getSecondChild();
return TR::TreeEvaluator::inlineIfBifEvaluator(ifNode, cg, cmpNode, valueNode);
}
TR::Node * firstChild = node-> getFirstChild(), * secondChild = node->getSecondChild();
#ifdef J9_PROJECT_SPECIFIC
if ((firstChild->getOpCodeValue() == TR::instanceof) &&
!(comp->getOption(TR_OptimizeForSpace) || debug("noInlineIfInstanceOf")) &&
(firstChild->getRegister() == NULL) &&
(node->getReferenceCount() <= 1) &&
secondChild->getOpCode().isLoadConst() &&
(((secondChild->getInt() == 0 || secondChild->getInt() == 1))
))
{
if (TR::TreeEvaluator::VMifInstanceOfEvaluator(node, cg) == NULL)
{
cg->decReferenceCount(secondChild);
return NULL;
}
}
#endif
bool inlined = false;
TR::Register *reg;
reg = TR::TreeEvaluator::inlineIfArraycmpEvaluator(node, cg, inlined);
if (inlined)
{
generateMergedGuardCodeIfNeeded(node, cg);
return reg;
}
reg = TR::TreeEvaluator::inlineIfTestDataClassHelper(node, cg, inlined);
if(inlined)
{
generateMergedGuardCodeIfNeeded(node, cg);
return reg;
}
#ifdef J9_PROJECT_SPECIFIC
if (cg->profiledPointersRequireRelocation() &&
node->isProfiledGuard() && secondChild->getOpCodeValue() == TR::aconst &&
(secondChild->isClassPointerConstant() || secondChild->isMethodPointerConstant()))
{
TR_VirtualGuard *virtualGuard = comp->findVirtualGuardInfo(node);
TR_AOTGuardSite *site = comp->addAOTNOPSite();
site->setType(virtualGuard->getKind());
site->setGuard(virtualGuard);
site->setNode(node);
site->setAconstNode(secondChild);
}
#endif
if (node->getOpCodeValue() == TR::ificmpeq ||
node->getOpCodeValue() == TR::ifiucmpeq ||
node->getOpCodeValue() == TR::ifacmpeq)
{
reg = generateS390CompareBranch(node, cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_BE, TR::InstOpCode::COND_BE);
}
else
{
reg = generateS390CompareBranch(node, cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_BNE, TR::InstOpCode::COND_BNE);
}
generateMergedGuardCodeIfNeeded(node, cg);
return reg;
}
/**
* Helper for ificmp(ge, gt, lt, le)
* this code was taken from ificmpeqEvaluator,
* but since ificmpeqEvaluator has more folding going on,
* it doesn't make sense to call this function from ificmpeqEvaluator
*/
TR::Register* OMR::Z::TreeEvaluator::ifFoldingHelper(TR::Node *node, TR::CodeGenerator *cg, bool &handledBIF)
{
handledBIF = true;
TR::Node * firstChild = node->getFirstChild(), * secondChild = node->getSecondChild();
bool inlined = false;
TR::Register *reg = TR::TreeEvaluator::inlineIfTestDataClassHelper(node, cg, inlined);
if(inlined)
return reg;
handledBIF = false;
return NULL;
}
/**
* Integer compare and branch if less than
*/
TR::Register *
OMR::Z::TreeEvaluator::ificmpltEvaluator(TR::Node * node, TR::CodeGenerator * cg)
{
bool inlined = false;
TR::Register *reg;
reg = TR::TreeEvaluator::inlineIfArraycmpEvaluator(node, cg, inlined);
if (inlined) return reg;
bool handledBIF = false;
TR::Register *result = TR::TreeEvaluator::ifFoldingHelper(node, cg, handledBIF);
if (handledBIF)
return result;
return generateS390CompareBranch(node, cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_BL, TR::InstOpCode::COND_BH);
}
/**
* Integer compare and branch if greater than or equal
*/
TR::Register *
OMR::Z::TreeEvaluator::ificmpgeEvaluator(TR::Node * node, TR::CodeGenerator * cg)
{
bool inlined = false;
TR::Register *reg;
reg = TR::TreeEvaluator::inlineIfArraycmpEvaluator(node, cg, inlined);
if (inlined) return reg;
bool handledBIF = false;
TR::Register *result = TR::TreeEvaluator::ifFoldingHelper(node, cg, handledBIF);
if (handledBIF)
return result;
return generateS390CompareBranch(node, cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_BNL, TR::InstOpCode::COND_BNH);
}
/**
* Integer compare and branch if greater than
*/
TR::Register *
OMR::Z::TreeEvaluator::ificmpgtEvaluator(TR::Node * node, TR::CodeGenerator * cg)
{
bool inlined = false;
TR::Register *reg;
reg = TR::TreeEvaluator::inlineIfArraycmpEvaluator(node, cg, inlined);
if (inlined) return reg;
bool handledBIF = false;
TR::Register *result = TR::TreeEvaluator::ifFoldingHelper(node, cg, handledBIF);
if (handledBIF)
return result;
return generateS390CompareBranch(node, cg, TR::InstOpCode::BRC, TR::InstOpCode::COND_BH, TR::InstOpCode::COND_BL);
}
/**
* Integer compare and branch if less than or equal
*/
TR::Register *
OMR::Z::TreeEvaluator::ificmpleEvaluator(TR::Node * node, TR::CodeGenerator * cg)
{
bool inlined = false;