-
Notifications
You must be signed in to change notification settings - Fork 747
/
Copy pathInterpreterEmulator.cpp
2033 lines (1829 loc) · 79.5 KB
/
InterpreterEmulator.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/InterpreterEmulator.hpp"
#include "optimizer/J9EstimateCodeSize.hpp"
#include "env/VMAccessCriticalSection.hpp"
#include "env/JSR292Methods.h"
#include "optimizer/PreExistence.hpp"
#include "optimizer/J9CallGraph.hpp"
#include "ilgen/IlGenRequest.hpp"
#include "jilconsts.h"
#include "il/ParameterSymbol.hpp"
#include "optimizer/PreExistence.hpp"
#include "optimizer/TransformUtil.hpp"
#include "il/Node_inlines.hpp"
#if defined(J9VM_OPT_JITSERVER)
#include "control/CompilationRuntime.hpp"
#include "env/j9methodServer.hpp"
#endif /* defined(J9VM_OPT_JITSERVER) */
const char* Operand::KnowledgeStrings[] = {"NONE", "OBJECT", "MUTABLE_CALLSITE_TARGET", "PREEXISTENT", "FIXED_CLASS", "KNOWN_OBJECT", "ICONST" };
char*
ObjectOperand::getSignature(TR::Compilation *comp, TR_Memory *trMemory)
{
if (!_signature && _clazz)
_signature = TR::Compiler->cls.classSignature(comp, _clazz, trMemory);
return _signature;
}
KnownObjOperand::KnownObjOperand(TR::KnownObjectTable::Index koi, TR_OpaqueClassBlock* clazz)
: knownObjIndex(koi), FixedClassOperand(clazz)
{
TR_ASSERT_FATAL(knownObjIndex != TR::KnownObjectTable::UNKNOWN, "Unexpected unknown object");
}
TR_OpaqueClassBlock*
KnownObjOperand::getClass()
{
if (_clazz)
return _clazz;
TR::Compilation* comp = TR::comp();
auto knot = comp->getOrCreateKnownObjectTable();
if (!knot || knot->isNull(knownObjIndex))
return NULL;
_clazz = comp->fej9()->getObjectClassFromKnownObjectIndex(comp, knownObjIndex);
return _clazz;
}
ObjectOperand*
KnownObjOperand::asObjectOperand()
{
if (getClass())
return this;
return NULL;
}
// FixedClassOperand need the class, if we can't get the class, return NULL
FixedClassOperand*
KnownObjOperand::asFixedClassOperand()
{
if (getClass())
return this;
return NULL;
}
Operand*
Operand::merge(Operand* other)
{
if (getKnowledgeLevel() > other->getKnowledgeLevel())
return other->merge1(this);
else
return merge1(other);
}
Operand*
Operand::merge1(Operand* other)
{
if (this == other)
return this;
else
return NULL;
}
Operand*
IconstOperand::merge1(Operand* other)
{
TR_ASSERT(other->getKnowledgeLevel() >= this->getKnowledgeLevel(), "Should be calling other->merge1(this)");
IconstOperand* otherIconst = other->asIconst();
if (otherIconst && this->intValue == otherIconst->intValue)
return this;
else
return NULL;
}
// TODO: check instanceOf relationship and create new Operand if neccessary
Operand*
ObjectOperand::merge1(Operand* other)
{
TR_ASSERT(other->getKnowledgeLevel() >= this->getKnowledgeLevel(), "Should be calling other->merge1(this)");
ObjectOperand* otherObject = other->asObjectOperand();
if (otherObject && this->_clazz == otherObject->_clazz)
return this;
else
return NULL;
}
// Both are preexistent objects
Operand*
PreexistentObjectOperand::merge1(Operand* other)
{
TR_ASSERT(other->getKnowledgeLevel() >= this->getKnowledgeLevel(), "Should be calling other->merge1(this)");
PreexistentObjectOperand* otherPreexistentObjectOperand = other->asPreexistentObjectOperand();
if (otherPreexistentObjectOperand && this->_clazz == otherPreexistentObjectOperand->_clazz)
return this;
else
return NULL;
}
Operand*
FixedClassOperand::merge1(Operand* other)
{
TR_ASSERT(other->getKnowledgeLevel() >= this->getKnowledgeLevel(), "Should be calling other->merge1(this)");
FixedClassOperand* otherFixedClass = other->asFixedClassOperand();
if (otherFixedClass && this->_clazz == otherFixedClass->_clazz)
return this;
else
return NULL;
}
Operand*
KnownObjOperand::merge1(Operand* other)
{
TR_ASSERT(other->getKnowledgeLevel() >= this->getKnowledgeLevel(), "Should be calling other->merge1(this)");
KnownObjOperand* otherKnownObj = other->asKnownObject();
if (otherKnownObj && this->knownObjIndex == otherKnownObj->knownObjIndex)
return this;
else
return NULL;
}
Operand*
MutableCallsiteTargetOperand::merge1(Operand* other)
{
TR_ASSERT(other->getKnowledgeLevel() >= this->getKnowledgeLevel(), "Should be calling other->merge1(this)");
MutableCallsiteTargetOperand* otherMutableCallsiteTarget = other->asMutableCallsiteTargetOperand();
if (otherMutableCallsiteTarget &&
this->mutableCallsiteIndex== otherMutableCallsiteTarget->mutableCallsiteIndex &&
this->methodHandleIndex == otherMutableCallsiteTarget->methodHandleIndex)
return this;
else
return NULL;
}
void
Operand::printToString(TR::StringBuf *buf)
{
buf->appendf("(unknown)");
}
void
IconstOperand::printToString(TR::StringBuf *buf)
{
buf->appendf("(iconst=%d)", intValue);
}
void
ObjectOperand::printToString(TR::StringBuf *buf)
{
buf->appendf("(%s=clazz%p)", KnowledgeStrings[getKnowledgeLevel()], getClass());
}
void
KnownObjOperand::printToString(TR::StringBuf *buf)
{
buf->appendf("(obj%d)", getKnownObjectIndex());
}
void
MutableCallsiteTargetOperand::printToString(TR::StringBuf *buf)
{
buf->appendf("(mh=%d, mcs=%d)", getMethodHandleIndex(), getMutableCallsiteIndex());
}
void
InterpreterEmulator::printOperandArray(OperandArray* operands)
{
int32_t size = operands->size();
for (int32_t i = 0; i < size; i++)
{
_operandBuf->clear();
(*operands)[i]->printToString(_operandBuf);
traceMsg(comp(), "[%d]=%s, ", i, _operandBuf->text());
}
if (size > 0)
traceMsg(comp(), "\n");
}
// Merge second OperandArray into the first one
// The merge does a union
//
void InterpreterEmulator::mergeOperandArray(OperandArray *first, OperandArray *second)
{
bool enableTrace = tracer()->debugLevel();
if (enableTrace)
{
traceMsg(comp(), "Operands before merging:\n");
printOperandArray(first);
}
bool changed = false;
for (int i = 0; i < _numSlots; i++)
{
Operand* firstObj = (*first)[i];
Operand* secondObj = (*second)[i];
firstObj = firstObj->merge(secondObj);
if (firstObj == NULL)
firstObj = _unknownOperand;
if (firstObj != (*first)[i])
changed = true;
}
if (enableTrace)
{
if (changed)
{
traceMsg(comp(), "Operands after merging:\n");
printOperandArray(first);
}
else
traceMsg(comp(), "Operands is not changed after merging\n");
}
}
/**
* \brief Add a required constant with \p value at the current bytecode index.
*
* There must not already be one.
*
* \param value the constant value
* \return a reference to the created TR::RequiredConst
*/
TR::RequiredConst &
InterpreterEmulator::addRequiredConst(TR::AnyConst value)
{
TR::Region &stackRegion = comp()->trMemory()->currentStackRegion();
auto insertResult = _calltarget->_requiredConsts.insert(
std::make_pair(_bcIndex, TR::RequiredConst(value, stackRegion)));
auto it = insertResult.first;
bool isNewEntry = insertResult.second;
TR_ASSERT_FATAL(isNewEntry, "multiple required consts at bcIndex %d", _bcIndex);
return it->second; // value
}
void
InterpreterEmulator::maintainStackForIf(TR_J9ByteCode bc)
{
TR_ASSERT_FATAL(_iteratorWithState, "has to be called when the iterator has state!");
TR_ASSERT_FATAL(bc == J9BCificmpeq || bc == J9BCificmpne, "InterpreterEmulator::maintainStackForIf can only be called with J9BCificmpeq and J9BCificmpne\n");
int32_t branchBC = _bcIndex + next2BytesSigned();
int32_t fallThruBC = _bcIndex + 3;
IconstOperand * second = pop()->asIconst();
IconstOperand * first = pop()->asIconst();
bool canBranch = true;
bool canFallThru = true;
// Comment out the branch folding as all the paths have to be interpreted in order
// to propagate object info in operand stack or local slots. Since branch folding
// currently only affects thunk archetypes, with similar branch folding in ilgen,
// calls in dead path won't be inlined, disabling the following code doesn't affect
// performance
// TODO: add code to record dead path and ignore it in object info propagation, enable
// the following code if branch folding is possible in LambdaForm methods
//
if (false && second && first)
{
switch (bc)
{
case J9BCificmpeq:
canBranch = second->intValue == first->intValue;
debugTrace(tracer(), "maintainStackForIf ifcmpeq %d == %d\n", second->intValue, first->intValue);
break;
case J9BCificmpne:
canBranch = second->intValue != first->intValue;
debugTrace(tracer(), "maintainStackForIf ifcmpne %d != %d\n", second->intValue, first->intValue);
break;
default:
break;
}
canFallThru = !canBranch;
}
// The branch target can be successor of the fall through, so gen fall through block first such
// that the predecessor is interpreted before the successor in order to propagate the operand
// stack and local slots state.
// This doesn't work when the fall through contain control flow, but there is no functional issue
// as the object info won't be propagated if there exists unvisited predecessor. This will be
// fixed when we traverse the bytecodes in reverse post order at CFG level.
//
if (canFallThru)
{
debugTrace(tracer(), "maintainStackForIf canFallThrough to bcIndex=%d\n", fallThruBC);
genTarget(fallThruBC);
}
if (canBranch)
{
debugTrace(tracer(), "maintainStackForIf canBranch to bcIndex=%d\n", branchBC);
genTarget(branchBC);
}
}
void
InterpreterEmulator::maintainStackForGetField()
{
TR_ASSERT_FATAL(_iteratorWithState, "has to be called when the iterator has state!");
TR::DataType type = TR::NoType;
uint32_t fieldOffset;
int32_t cpIndex = next2Bytes();
Operand *newOperand = _unknownOperand;
TR::Symbol *fieldSymbol = TR::Symbol::createPossiblyRecognizedShadowFromCP(
comp(), trStackMemory(), _calltarget->_calleeMethod, cpIndex, &type, &fieldOffset, false);
TR::KnownObjectTable *knot = comp()->getKnownObjectTable();
if (knot &&
top()->asKnownObject() &&
!knot->isNull(top()->getKnownObjectIndex())
&& type == TR::Address)
{
if (fieldSymbol == NULL)
{
debugTrace(tracer(), "field is unresolved");
}
else if (!comp()->fej9()->canDereferenceAtCompileTimeWithFieldSymbol(fieldSymbol, cpIndex, _calltarget->_calleeMethod))
{
debugTrace(tracer(), "field is not foldable");
}
else
{
TR::KnownObjectTable::Index baseObjectIndex = top()->getKnownObjectIndex();
TR::KnownObjectTable::Index resultIndex = TR::KnownObjectTable::UNKNOWN;
uintptr_t baseObjectAddress = 0;
uintptr_t fieldAddress = 0;
bool avoidFolding = true;
#if defined(J9VM_OPT_JITSERVER)
if (comp()->isOutOfProcessCompilation())
{
TR_ResolvedJ9JITServerMethod *serverMethod = static_cast<TR_ResolvedJ9JITServerMethod *>(_calltarget->_calleeMethod);
TR_ResolvedMethod *clientMethod = serverMethod->getRemoteMirror();
auto stream = comp()->getStream();
stream->write(JITServer::MessageType::KnownObjectTable_dereferenceKnownObjectField,
baseObjectIndex, clientMethod, cpIndex);
auto recv = stream->read<TR::KnownObjectTable::Index, uintptr_t *, uintptr_t, uintptr_t, bool>();
resultIndex = std::get<0>(recv);
uintptr_t *objectPointerReference = std::get<1>(recv);
fieldAddress = std::get<2>(recv);
baseObjectAddress = std::get<3>(recv);
avoidFolding = std::get<4>(recv);
if (resultIndex != TR::KnownObjectTable::UNKNOWN)
knot->updateKnownObjectTableAtServer(resultIndex, objectPointerReference);
}
else
#endif /* defined(J9VM_OPT_JITSERVER) */
{
TR::VMAccessCriticalSection dereferenceKnownObjectField(comp()->fej9());
baseObjectAddress = knot->getPointer(baseObjectIndex);
TR_OpaqueClassBlock *baseObjectClass = comp()->fej9()->getObjectClass(baseObjectAddress);
TR_OpaqueClassBlock *fieldDeclaringClass = _calltarget->_calleeMethod->getDeclaringClassFromFieldOrStatic(comp(), cpIndex);
avoidFolding = TR::TransformUtil::avoidFoldingInstanceField(
baseObjectAddress, fieldSymbol, fieldOffset, cpIndex, _calltarget->_calleeMethod, comp());
if (fieldDeclaringClass && comp()->fej9()->isInstanceOf(baseObjectClass, fieldDeclaringClass, true) == TR_yes)
{
fieldAddress = comp()->fej9()->getReferenceFieldAtAddress(baseObjectAddress + fieldOffset);
resultIndex = knot->getOrCreateIndex(fieldAddress);
}
}
bool fail = resultIndex == TR::KnownObjectTable::UNKNOWN;
if (fail || avoidFolding)
{
int32_t len = 0;
debugTrace(
tracer(),
"%s field in obj%d: %s",
fail ? "failed to determine value of" : "avoid folding sometimes-foldable",
baseObjectIndex,
_calltarget->_calleeMethod->fieldName(cpIndex, len, this->trMemory()));
}
else
{
// It's OK to print fieldAddress and baseObjectAddress here even
// without VM access. There's no meaningful difference between:
// - printing the object's address, then allowing it to move; and
// - observing the objects's address, then allowing it to move,
// then finally printing the observed address.
newOperand = new (trStackMemory()) KnownObjOperand(resultIndex);
int32_t len = 0;
debugTrace(tracer(), "dereference obj%d (%p)from field %s(offset = %d) of base obj%d(%p)\n",
newOperand->getKnownObjectIndex(), (void *)fieldAddress, _calltarget->_calleeMethod->fieldName(cpIndex, len, this->trMemory()),
fieldOffset, baseObjectIndex, baseObjectAddress);
if (resultIndex != TR::KnownObjectTable::UNKNOWN)
{
auto value = TR::AnyConst::makeKnownObject(resultIndex);
addRequiredConst(value);
}
}
}
}
pop();
push(newOperand);
}
void
InterpreterEmulator::saveStack(int32_t targetIndex)
{
if (!_iteratorWithState)
return;
// Propagate stack state to successor
if (!_stack->isEmpty())
{
if (!_stacks[targetIndex])
_stacks[targetIndex] = new (trStackMemory()) ByteCodeStack(*_stack);
else
{
TR_ASSERT_FATAL(_stacks[targetIndex]->size() == _stack->size(), "operand stack from two paths must have the same size, predecessor bci %d target bci %d\n", _bcIndex, targetIndex);
mergeOperandArray(_stacks[targetIndex], _stack);
}
}
// Propagate local object info to successor
if (_numSlots)
{
if (!_localObjectInfos[targetIndex])
_localObjectInfos[targetIndex] = new (trStackMemory()) OperandArray(*_currentLocalObjectInfo);
else
mergeOperandArray(_localObjectInfos[targetIndex], _currentLocalObjectInfo);
}
}
void
InterpreterEmulator::initializeIteratorWithState()
{
_iteratorWithState = true;
_unknownOperand = new (trStackMemory()) Operand();
uint32_t size = this->maxByteCodeIndex() + 5;
_flags = (flags8_t *) this->trMemory()->allocateStackMemory(size * sizeof(flags8_t));
_stacks = (ByteCodeStack * *) this->trMemory()->allocateStackMemory(size * sizeof(ByteCodeStack *));
memset(_flags, 0, size * sizeof(flags8_t));
memset(_stacks, 0, size * sizeof(ByteCodeStack *));
_stack = new (trStackMemory()) TR_Stack<Operand *>(this->trMemory(), 20, false, stackAlloc);
_localObjectInfos = (OperandArray**) this->trMemory()->allocateStackMemory(size * sizeof(OperandArray *));
memset(_localObjectInfos, 0, size * sizeof(OperandArray *));
int32_t numParmSlots = method()->numberOfParameterSlots();
_numSlots = numParmSlots + method()->numberOfTemps();
genBBStart(0);
setupBBStartContext(0);
this->setIndex(0);
}
void
InterpreterEmulator::setupMethodEntryLocalObjectState()
{
TR_PrexArgInfo *argInfo = _calltarget->_ecsPrexArgInfo;
if (argInfo)
{
TR_ASSERT_FATAL(argInfo->getNumArgs() == method()->numberOfParameters(), "Prex arg number should match parm number");
if(tracer()->heuristicLevel())
{
heuristicTrace(tracer(), "Save argInfo to slot state array");
argInfo->dumpTrace();
}
method()->makeParameterList(_methodSymbol);
ListIterator<TR::ParameterSymbol> parms(&_methodSymbol->getParameterList());
// save prex arg into local var arrays
for (TR::ParameterSymbol *p = parms.getFirst(); p != NULL; p = parms.getNext())
{
int32_t ordinal = p->getOrdinal();
int32_t slotIndex = p->getSlot();
TR_PrexArgument *prexArgument = argInfo->get(ordinal);
if (!prexArgument)
{
(*_currentLocalObjectInfo)[slotIndex] = _unknownOperand;
}
else
{
auto operand = createOperandFromPrexArg(prexArgument);
if (operand)
{
(*_currentLocalObjectInfo)[slotIndex] = operand;
}
else
(*_currentLocalObjectInfo)[slotIndex] = _unknownOperand;
}
if (tracer()->heuristicLevel())
{
_operandBuf->clear();
(*_currentLocalObjectInfo)[slotIndex]->printToString(_operandBuf);
heuristicTrace(
tracer(),
"Creating operand %s for parm %d slot %d from PrexArgument %p",
_operandBuf->text(),
ordinal,
slotIndex,
prexArgument);
}
}
}
}
bool
InterpreterEmulator::hasUnvisitedPred(TR::Block* block)
{
TR_PredecessorIterator pi(block);
for (TR::CFGEdge *edge = pi.getFirst(); edge != NULL; edge = pi.getNext())
{
TR::Block *fromBlock = toBlock(edge->getFrom());
auto fromBCIndex = fromBlock->getEntry()->getNode()->getByteCodeIndex();
if (!isGenerated(fromBCIndex))
{
return true;
}
}
return false;
}
void
InterpreterEmulator::setupBBStartStackState(int32_t index)
{
if (index == 0)
return;
auto block = blocks(index);
auto stack = _stacks[index];
if (stack && hasUnvisitedPred(block))
{
heuristicTrace(tracer(), "block_%d at bc index %d has unvisited predecessor, setting stack operand info to unknown", block->getNumber(), index);
for (int32_t i = 0; i < stack->size(); ++i)
(*stack)[i] = _unknownOperand;
}
}
void
InterpreterEmulator::setupBBStartLocalObjectState(int32_t index)
{
if (_numSlots == 0)
return;
if (!_localObjectInfos[index])
{
_localObjectInfos[index] = new (trStackMemory()) OperandArray(trMemory(), _numSlots, false, stackAlloc);
for (int32_t i = 0; i < _numSlots; i++)
(*_localObjectInfos[index])[i] = _unknownOperand;
}
else if (hasUnvisitedPred(blocks(index)))
{
heuristicTrace(tracer(), "block_%d at bc index %d has unvisited predecessor, setting local object info to unknown", blocks(index)->getNumber(), index);
for (int32_t i = 0; i < _numSlots; i++)
(*_localObjectInfos[index])[i] = _unknownOperand;
}
_currentLocalObjectInfo = _localObjectInfos[index];
if (index == 0)
setupMethodEntryLocalObjectState();
}
int32_t
InterpreterEmulator::setupBBStartContext(int32_t index)
{
if (_iteratorWithState)
{
setupBBStartStackState(index);
setupBBStartLocalObjectState(index);
}
Base::setupBBStartContext(index);
return index;
}
bool
InterpreterEmulator::maintainStack(TR_J9ByteCode bc)
{
TR_ASSERT_FATAL(_iteratorWithState, "has to be called when the iterator has state!");
int slotIndex = -1;
switch (bc)
{
case J9BCgetfield: maintainStackForGetField(); break;
case J9BCaload0: slotIndex = 0; maintainStackForAload(slotIndex); break;
case J9BCaload1: slotIndex = 1; maintainStackForAload(slotIndex); break;
case J9BCaload2: slotIndex = 2; maintainStackForAload(slotIndex); break;
case J9BCaload3: slotIndex = 3; maintainStackForAload(slotIndex); break;
case J9BCaload: slotIndex = nextByte(); maintainStackForAload(slotIndex); break;
case J9BCaloadw: slotIndex = next2Bytes(); maintainStackForAload(slotIndex); break;
case J9BCinvokespecial:
case J9BCinvokespecialsplit:
case J9BCinvokevirtual:
case J9BCinvokestatic:
case J9BCinvokestaticsplit:
case J9BCinvokedynamic:
case J9BCinvokehandle:
maintainStackForCall();
break;
case J9BCiconstm1: push (new (trStackMemory()) IconstOperand(-1)); break;
case J9BCiconst0: push (new (trStackMemory()) IconstOperand(0)); break;
case J9BCiconst1: push (new (trStackMemory()) IconstOperand(1)); break;
case J9BCiconst2: push (new (trStackMemory()) IconstOperand(2)); break;
case J9BCiconst3: push (new (trStackMemory()) IconstOperand(3)); break;
case J9BCiconst4: push (new (trStackMemory()) IconstOperand(4)); break;
case J9BCiconst5: push (new (trStackMemory()) IconstOperand(5)); break;
case J9BCifne:
push (new (trStackMemory()) IconstOperand(0));
maintainStackForIf(J9BCificmpne);
break;
case J9BCifeq:
push (new (trStackMemory()) IconstOperand(0));
maintainStackForIf(J9BCificmpeq);
break;
case J9BCgoto:
genTarget(bcIndex() + next2BytesSigned());
break;
case J9BCpop:
case J9BCputfield:
case J9BCputstatic:
pop();
break;
case J9BCladd:
case J9BCiadd:
case J9BCisub:
case J9BCiand:
popn(2);
pushUnknownOperand();
break;
case J9BCistore: case J9BClstore: case J9BCfstore: case J9BCdstore:
case J9BCistorew: case J9BClstorew: case J9BCfstorew: case J9BCdstorew:
case J9BCistore0: case J9BCistore1: case J9BCistore2: case J9BCistore3:
case J9BClstore0: case J9BClstore1: case J9BClstore2: case J9BClstore3:
case J9BCfstore0: case J9BCfstore1: case J9BCfstore2: case J9BCfstore3:
case J9BCdstore0: case J9BCdstore1: case J9BCdstore2: case J9BCdstore3:
pop();
break;
// Maintain stack for object store
case J9BCastorew: maintainStackForAstore(next2Bytes()); break;
case J9BCastore: maintainStackForAstore(nextByte()); break;
case J9BCastore0: maintainStackForAstore(0); break;
case J9BCastore1: maintainStackForAstore(1); break;
case J9BCastore2: maintainStackForAstore(2); break;
case J9BCastore3: maintainStackForAstore(3); break;
case J9BCiload0: case J9BCiload1: case J9BCiload2: case J9BCiload3:
case J9BCdload0: case J9BCdload1: case J9BCdload2: case J9BCdload3:
case J9BClload0: case J9BClload1: case J9BClload2: case J9BClload3:
case J9BCfload0: case J9BCfload1: case J9BCfload2: case J9BCfload3:
case J9BCiloadw: case J9BClloadw: case J9BCfloadw: case J9BCdloadw:
case J9BCiload: case J9BClload: case J9BCfload: case J9BCdload:
pushUnknownOperand();
break;
case J9BCgetstatic:
maintainStackForGetStatic();
break;
case J9BCgenericReturn:
case J9BCReturnC:
case J9BCReturnS:
case J9BCReturnB:
case J9BCReturnZ:
maintainStackForReturn();
break;
case J9BCi2l:
break;
case J9BCcheckcast:
break;
case J9BCdup:
push(top());
break;
case J9BCldc:
maintainStackForldc(nextByte()); break;
default:
static const bool assertfatal = feGetEnv("TR_AssertFatalForUnexpectedBytecodeInMethodHandleThunk") ? true: false;
if (!assertfatal)
debugTrace(tracer(), "unexpected bytecode in thunk archetype %s (%p) at bcIndex %d %s (%d)\n", _calltarget->_calleeMethod->signature(comp()->trMemory()), _calltarget, bcIndex(), comp()->fej9()->getByteCodeName(nextByte(0)), bc);
else
TR_ASSERT_FATAL(0, "unexpected bytecode in thunk archetype %s (%p) at bcIndex %d %s (%d)\n", _calltarget->_calleeMethod->signature(comp()->trMemory()), _calltarget, bcIndex(), comp()->fej9()->getByteCodeName(nextByte(0)), bc);
TR::DebugCounter::incStaticDebugCounter(comp(),
TR::DebugCounter::debugCounterName(comp(),
"InterpreterEmulator.unexpectedBytecode/(root=%s)/(%s)/bc=%d/%s",
comp()->signature(),
_calltarget->_calleeMethod->signature(comp()->trMemory()),
_bcIndex,
comp()->fej9()->getByteCodeName(nextByte(0)))
);
return false;
}
return true;
}
void
InterpreterEmulator::maintainStackForReturn()
{
if (method()->returnType() != TR::NoType)
pop();
}
void
InterpreterEmulator::maintainStackForGetStatic()
{
TR_ASSERT_FATAL(_iteratorWithState, "has to be called when the iterator has state!");
if (comp()->compileRelocatableCode())
{
pushUnknownOperand();
return;
}
int32_t cpIndex = next2Bytes();
debugTrace(tracer(), "getstatic cpIndex %d", cpIndex);
void * dataAddress;
bool isVolatile, isPrivate, isUnresolvedInCP, isFinal;
TR::DataType type = TR::NoType;
auto owningMethod = _calltarget->_calleeMethod;
bool resolved = owningMethod->staticAttributes(
comp(),
cpIndex,
&dataAddress,
&type,
&isVolatile,
&isFinal,
&isPrivate,
false,
&isUnresolvedInCP);
TR_YesNoMaybe canFold = TR_no;
TR::Symbol::RecognizedField recField = TR::Symbol::UnknownField;
if (resolved && isFinal)
{
bool isStatic = true;
recField =
TR::Symbol::searchRecognizedField(comp(), owningMethod, cpIndex, isStatic);
TR_OpaqueClassBlock *declaringClass =
owningMethod->getDeclaringClassFromFieldOrStatic(comp(), cpIndex);
canFold =
TR::TransformUtil::canFoldStaticFinalField(
comp(), declaringClass, recField, owningMethod, cpIndex);
}
TR::KnownObjectTable::Index knownObjectIndex = TR::KnownObjectTable::UNKNOWN;
if (canFold == TR_yes && type == TR::Address)
{
TR::AnyConst value = TR::AnyConst::makeAddress(0);
bool gotValue = TR::TransformUtil::staticFinalFieldValue(
comp(), owningMethod, cpIndex, dataAddress, TR::Address, recField, &value);
if (gotValue && value.isKnownObject())
{
knownObjectIndex = value.getKnownObjectIndex();
addRequiredConst(value);
}
}
if (knownObjectIndex != TR::KnownObjectTable::UNKNOWN)
push(new (trStackMemory()) KnownObjOperand(knownObjectIndex));
else
pushUnknownOperand();
}
void
InterpreterEmulator::maintainStackForAload(int slotIndex)
{
TR_ASSERT_FATAL(_iteratorWithState, "has to be called when the iterator has state!");
push((*_currentLocalObjectInfo)[slotIndex]);
}
void
InterpreterEmulator::maintainStackForAstore(int slotIndex)
{
TR_ASSERT_FATAL(_iteratorWithState, "has to be called when the iterator has state!");
(*_currentLocalObjectInfo)[slotIndex] = pop();
}
void
InterpreterEmulator::maintainStackForldc(int32_t cpIndex)
{
TR::DataType type = method()->getLDCType(cpIndex);
switch (type)
{
case TR::Address:
// TODO: should add a function to check if cp entry is unresolved for all constant
// not just for string. Currently only do it for string because it may be patched
// to a different object in OpenJDK MethodHandle implementation
//
if (method()->isStringConstant(cpIndex) && !method()->isUnresolvedString(cpIndex))
{
uintptr_t * location = (uintptr_t *)method()->stringConstant(cpIndex);
TR::KnownObjectTable *knot = comp()->getKnownObjectTable();
if (knot)
{
TR::KnownObjectTable::Index koi = knot->getOrCreateIndexAt(location);
push(new (trStackMemory()) KnownObjOperand(koi));
debugTrace(tracer(), "aload known obj%d from ldc %d", koi, cpIndex);
return;
}
}
break;
default:
break;
}
pushUnknownOperand();
}
void
InterpreterEmulator::maintainStackForCall(Operand *result, int32_t numArgs, TR::DataType returnType)
{
TR_ASSERT_FATAL(_iteratorWithState, "has to be called when the iterator has state!");
for (int i = 1; i <= numArgs; i++)
pop();
if (result)
push(result);
else if (returnType != TR::NoType)
pushUnknownOperand();
}
void
InterpreterEmulator::maintainStackForCall()
{
TR_ASSERT_FATAL(_iteratorWithState, "has to be called when the iterator has state!");
int32_t numOfArgs = -1;
TR::DataType returnType = TR::NoType;
Operand* result = NULL;
if (_currentCallMethod)
result = getReturnValue(_currentCallMethod);
// If the caller is thunk archetype, the load of parm `argPlaceholder` can
// be expanded to loads of multiple arguments, so we can't pop the number
// of arguments of a refined call
//
if (_currentCallSite && !_callerIsThunkArchetype)
{
if (_currentCallSite->_isInterface)
{
numOfArgs = _currentCallSite->_interfaceMethod->numberOfExplicitParameters() + 1;
returnType = _currentCallSite->_interfaceMethod->returnType();
}
else if (_currentCallSite->_initialCalleeMethod)
{
numOfArgs = _currentCallSite->_initialCalleeMethod->numberOfParameters();
returnType = _currentCallSite->_initialCalleeMethod->returnType();
}
}
else
{
int32_t cpIndex = next2Bytes();
bool isStatic = false;
switch (current())
{
case J9BCinvokespecialsplit:
cpIndex |= J9_SPECIAL_SPLIT_TABLE_INDEX_FLAG;
break;
case J9BCinvokestaticsplit:
cpIndex |= J9_STATIC_SPLIT_TABLE_INDEX_FLAG;
case J9BCinvokestatic:
isStatic = true;
break;
case J9BCinvokedynamic:
{
// Find the signature, which corresponds to the arguments on the stack.
// cpIndex is really the invokedynamic call site index
J9ROMClass *romClass = TR::Compiler->cls.romClassOf(method()->classOfMethod());
J9SRP *namesAndSigs = (J9SRP*)J9ROMCLASS_CALLSITEDATA(romClass);
J9ROMNameAndSignature *nameAndSig = NNSRP_GET(namesAndSigs[cpIndex], J9ROMNameAndSignature*);
J9UTF8 *sig = J9ROMNAMEANDSIGNATURE_SIGNATURE(nameAndSig);
// Parse the signature to determine the number of arguments and
// whether or not there is a return value.
U_8 sigTypes[256]; // signatures are limited to 255 params + 1 return type
UDATA numParams = 0;
UDATA numParamSlots = 0;
jitParseSignature(sig, sigTypes, &numParams, &numParamSlots);
numOfArgs = numParams;
// returnType is only used to distinguish void return (TR::NoType)
// from non-void return (any other value), so it's not necessary to
// get the correct non-void type here.
if (sigTypes[numParams] == J9_NATIVE_TYPE_VOID)
returnType = TR::NoType;
else
returnType = TR::Int32;
break;
}
default:
break;
}
if (numOfArgs < 0)
{
TR::Method * calleeMethod = comp()->fej9()->createMethod(trMemory(), _calltarget->_calleeMethod->containingClass(), cpIndex);
numOfArgs = calleeMethod->numberOfExplicitParameters() + (isStatic ? 0 : 1);
returnType = calleeMethod->returnType();
}
}
maintainStackForCall(result, numOfArgs, returnType);
}
void
InterpreterEmulator::dumpStack()
{
if (!tracer()->debugLevel())
return;
debugTrace(tracer(), "operandStack after bytecode %d : %s ", _bcIndex, comp()->fej9()->getByteCodeName(nextByte(0)));
for (int i = 0; i < _stack->size(); i++ )
{
Operand *x = (*_stack)[i];
_operandBuf->clear();
x->printToString(_operandBuf);
debugTrace(tracer(), "[%d]=%s", i, _operandBuf->text());
}
}
Operand *
InterpreterEmulator::getReturnValue(TR_ResolvedMethod *callee)
{
if (!callee)
return NULL;
Operand *result = NULL;
TR::RecognizedMethod recognizedMethod = callee->getRecognizedMethod();
TR::KnownObjectTable *knot = comp()->getKnownObjectTable();
TR::IlGeneratorMethodDetails & details = comp()->ilGenRequest().details();
if (_callerIsThunkArchetype && details.isMethodHandleThunk())
{
J9::MethodHandleThunkDetails & thunkDetails = static_cast<J9::MethodHandleThunkDetails &>(details);
if (!thunkDetails.isCustom())
recognizedMethod = TR::unknownMethod;
}
switch (recognizedMethod)
{
case TR::java_lang_invoke_ILGenMacros_isCustomThunk:
result = new (trStackMemory()) IconstOperand(1);
break;
case TR::java_lang_invoke_ILGenMacros_isShareableThunk:
result = new (trStackMemory()) IconstOperand(0);
break;
#if defined(J9VM_OPT_OPENJDK_METHODHANDLE)
case TR::java_lang_invoke_DelegatingMethodHandle_getTarget:
{
TR::KnownObjectTable::Index dmhIndex = top()->getKnownObjectIndex();
bool trace = tracer()->debugLevel();
TR::KnownObjectTable::Index targetIndex =
comp()->fej9()->delegatingMethodHandleTarget(comp(), dmhIndex, trace);
if (targetIndex == TR::KnownObjectTable::UNKNOWN)