-
Notifications
You must be signed in to change notification settings - Fork 397
/
Copy pathOMRCompilation.hpp
1357 lines (1094 loc) · 54 KB
/
OMRCompilation.hpp
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, 2020 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
*******************************************************************************/
#ifndef OMR_COMPILATION_INCL
#define OMR_COMPILATION_INCL
/*
* The following #define and typedef must appear before any #includes in this file
*/
#ifndef OMR_COMPILATION_CONNECTOR
#define OMR_COMPILATION_CONNECTOR
namespace OMR { class Compilation; }
namespace OMR { typedef OMR::Compilation CompilationConnector; }
#endif
/**
* \file OMRCompilation.hpp
* \brief Header for OMR::Compilation, root of the Compilation extensible class hierarchy.
*/
#include <stdarg.h>
#include <stddef.h>
#include <stdint.h>
#include "env/FrontEnd.hpp"
#include "codegen/RecognizedMethods.hpp"
#include "compile/CompilationTypes.hpp"
#include "compile/OSRData.hpp"
#include "compile/Method.hpp"
#include "compile/TLSCompilationManager.hpp"
#include "control/OptimizationPlan.hpp"
#include "control/Options.hpp" // For Options
#include "control/Options_inlines.hpp"
#include "cs2/timer.h"
#include "env/PersistentInfo.hpp"
#include "env/TRMemory.hpp"
#include "env/Region.hpp"
#include "env/jittypes.h"
#include "il/DataTypes.hpp"
#include "il/IL.hpp"
#include "il/Node.hpp"
#include "il/ResolvedMethodSymbol.hpp"
#include "infra/Array.hpp"
#include "infra/Flags.hpp"
#include "infra/Link.hpp"
#include "infra/List.hpp"
#include "infra/Stack.hpp"
#include "infra/ThreadLocal.hpp"
#include "optimizer/Optimizations.hpp"
#include "ras/Debug.hpp"
#include "ras/DebugCounter.hpp"
#include "ras/ILValidationStrategies.hpp"
class TR_AOTGuardSite;
class TR_BitVector;
class TR_CHTable;
class TR_FrontEnd;
class TR_HWPRecord;
class TR_IlGenerator;
class TR_OptimizationPlan;
class TR_OSRCompilationData;
class TR_PersistentClassInfo;
class TR_PrexArgInfo;
class TR_RandomGenerator;
class TR_RegisterCandidates;
class TR_ResolvedMethod;
namespace OMR { class RuntimeAssumption; }
class TR_VirtualGuard;
class TR_VirtualGuardSite;
struct TR_VirtualGuardSelection;
namespace TR { class Block; }
namespace TR { class CFG; }
namespace TR { class CodeCache; }
namespace TR { class CodeGenerator; }
namespace TR { class Compilation; }
namespace TR { class IlGenRequest; }
namespace TR { class IlVerifier; }
namespace TR { class ILValidator; }
namespace TR { class Instruction; }
namespace TR { class KnownObjectTable; }
namespace TR { class LabelSymbol; }
namespace TR { class Node; }
namespace TR { class NodePool; }
namespace TR { class Options; }
namespace TR { class Optimizer; }
namespace TR { class Recompilation; }
namespace TR { class RegisterMappedSymbol; }
namespace TR { class ResolvedMethodSymbol; }
namespace TR { class Symbol; }
namespace TR { class SymbolReference; }
namespace TR { class SymbolReferenceTable; }
namespace TR { class TreeTop; }
namespace TR { class TypeLayout; }
typedef TR::SparseBitVector SharedSparseBitVector;
#if _AIX
#define STRTOK(a,b,c) strtok_r(a,b,c)
#else
#define STRTOK(a,b,c) strtok(a,b)
#endif
// Return codes from the compilation. Any non-zero return code will abort the
// compilation.
enum CompilationReturnCodes
{
COMPILATION_SUCCEEDED = 0,
COMPILATION_REQUESTED,
COMPILATION_IL_GEN_FAILURE,
COMPILATION_IL_VALIDATION_FAILURE,
COMPILATION_UNIMPL_OPCODE,
// Keep this the last one
COMPILATION_FAILED
};
enum ProfilingMode
{
DisabledProfiling,
JitProfiling,
JProfiling
};
#if defined(DEBUG)
// For a production build the body of of TR::Compilation::diagnostic is empty, so
// the call will be inlined and become a NOP. The problem is that unless the
// compiler is very smart, it will continue to add the string (the first argument)
// to the dll. The use of these macros should ensure that the string is not added to
// the dll.
//
#if defined(_MSC_VER)
#define diagnostic( msg, ...) (TR::comp()->diagnosticImpl(msg, __VA_ARGS__))
#else // XLC or GCC
#define diagnostic(msg, ...) (TR::comp()->diagnosticImpl(msg, ##__VA_ARGS__))
#endif
/**
* Returns true if 'option' exists inside the environment variable
* TR_DEBUG or has been passsed as trDebug=, or an option has been
* hooked up to setDebug.
*/
char *debug(const char * option);
void addDebug(const char * string);
#else
#define diagnostic(msg, ...) ((void)0)
#define debug(option) 0
#define addDebug(string) ((void)0)
#endif
/**
* \def performTransformation(comp, msg, ...)
*
* \brief Macro that is used to guard optional steps in compilation in order to
* aid debuggability
*
*
* Ostensibly, the purpose of performTransformation is to allow code
* transformations to be selectively disabled during debugging in order to
* isolate a buggy optimization. But this description fails to capture the
* important effect that performTransformation has on the maintainability of
* Testarossa's code base.
*
* Calls to performTransformation can (and should) be placed around any part of
* the code that is optional; in an optimizer, that's a lot of code. Tons of
* Testarossa code is there only to improve performance-not for correctness-and
* can therefore be guarded by performTransformation.
*
* A call in a hypothetical dead code elimination might look like this:
*
* if (performTransformation2c(comp(),
* "%sDeleting dead candidate [%p]\n", OPT_DETAILS, candidate->_node))
* {
* // Logic to delete some dead code.
* }
*
* When this opt runs on a method that is being logged, all calls to
* performTransformation will be assigned a unique number. Running the test
* case with lastOptTransformationIndex=n will prevent subsequent
* transformations from occurring. By adjusting n and observing when the test
* passes and fails, it is possible to narrow down the failing transformation
* using a binary-search approach.
*
* But beyond just allowing this opt to be enabled and disabled, this idiom
* also does the following:
*
* - It describes what the code does without needing a comment
* - It reports the transformation in the log
* - It gives people unfamiliar with the opt a way to locate the code that
* caused a particular transformation
* - Combined with countOptTransformations, it allows you to locate methods
* in which this opt is occurring
*
* Most importantly, it identifies exactly the code that should be skipped if
* someone wanted to prevent this opt from occurring in certain cases. Even if
* you know nothing about an optimization, you can locate its
* performTransformation call(s) and add an additional clause to this "if"
* statement, secure in the knowledge that skipping this code will not leave
* the optimization in some undefined state. The author of the optimization
* has identified this code as "skippable", so you can be fairly certain that
* skipping it will do just what you want.
*
* If you are developing code that has optional parts, it is strongly
* recommended to guard them with performTransformation. It is likely to help
* you debug your code immediately, and will certainly help people after you to
* maintain and experiment with the code.
*/
#if defined(NO_OPT_DETAILS)
#define traceMsg(comp, msg, ...) ((void)0)
#define dumpOptDetails(comp, msg, ...) ((void)0)
#define traceMsgVarArgs(comp, msg, arg) ((void)0)
#define performTransformation(comp, msg, ...) ((comp)->getOptimizer()? (comp)->getOptimizer()->incOptMessageIndex() > 0: true)
#define performNodeTransformation0(comp,a) (true)
#define performNodeTransformation1(comp,a,b) (true)
#define performNodeTransformation2(comp,a,b,c) (true)
#define performNodeTransformation3(comp,a,b,c,d) (true)
#else // of NO_OPT_DETAILS
#define DumpOptDetailsDefined 1
#define TRACE_OPT_DETAILS(comp) (comp)->getOptions()->getAnyOption(TR_TraceOptDetails|TR_CountOptTransformations)
#define traceMsgVarArgs(comp, msg, arg) \
((comp)->getDebug() ? \
(comp)->getDebug()->vtrace(msg, arg) : \
(void)0)
#if defined(_MSC_VER)
#define traceMsg(comp, msg, ...) \
((comp)->getDebug() ? \
(comp)->getDebug()->trace(msg, __VA_ARGS__) : \
(void)0)
#define dumpOptDetails(comp, msg, ...) \
(TRACE_OPT_DETAILS(comp) ? \
(comp)->getDebug()->performTransformationImpl(false, msg, __VA_ARGS__) : \
true)
#define performTransformation(comp, msg, ...) \
(TRACE_OPT_DETAILS(comp) ? \
(comp)->getDebug()->performTransformationImpl(true, msg, __VA_ARGS__) : \
((comp)->getOptimizer() ? (comp)->getOptimizer()->incOptMessageIndex() > 0 : true))
#else // XLC or GCC
#define traceMsg(comp, msg, ...) \
((comp)->getDebug() ? \
(comp)->getDebug()->trace(msg, ##__VA_ARGS__) : \
(void)0)
#define dumpOptDetails(comp, msg, ...) \
(TRACE_OPT_DETAILS(comp) ? \
(comp)->getDebug()->performTransformationImpl(false, msg, ##__VA_ARGS__) : \
true)
#define performTransformation(comp, msg, ...) \
(TRACE_OPT_DETAILS(comp) ? \
(comp)->getDebug()->performTransformationImpl(true, msg, ##__VA_ARGS__) : \
((comp)->getOptimizer() ? (comp)->getOptimizer()->incOptMessageIndex() > 0 : true))
#endif // compiler checks
#define performNodeTransformation0(comp,a) (comp->getOption(TR_TraceNodeFlags) ? performTransformation(comp,a) : true)
#define performNodeTransformation1(comp,a,b) (comp->getOption(TR_TraceNodeFlags) ? performTransformation(comp,a,b) : true)
#define performNodeTransformation2(comp,a,b,c) (comp->getOption(TR_TraceNodeFlags) ? performTransformation(comp,a,b,c) : true)
#define performNodeTransformation3(comp,a,b,c,d) (comp->getOption(TR_TraceNodeFlags) ? performTransformation(comp,a,b,c,d) : true)
#endif
namespace OMR
{
class OMR_EXTENSIBLE Compilation
{
friend class ::TR_DebugExt;
public:
TR_ALLOC(TR_Memory::Compilation)
Compilation(
int32_t compThreadId,
OMR_VMThread *omrVMThread,
TR_FrontEnd *,
TR_ResolvedMethod *,
TR::IlGenRequest &,
TR::Options &,
TR::Region &heapMemoryRegion,
TR_Memory *,
TR_OptimizationPlan *optimizationPlan,
TR::Environment *target = NULL
);
TR::SymbolReference * getSymbolReferenceByReferenceNumber(int32_t referenceNumber);
~Compilation() throw();
inline TR::Compilation *self();
TR::Region ®ion() { return _heapMemoryRegion; }
TR::IL il;
TR::IlGenRequest &ilGenRequest() { return _ilGenRequest; }
TR::CodeGenerator *cg() { return _codeGenerator; }
TR_FrontEnd *fe() { return _fe; }
TR::Options *getOptions() { return _options; }
TR_Memory *trMemory() { return _trMemory; }
TR_StackMemory trStackMemory() { return _trMemory; }
TR_HeapMemory trHeapMemory() { return _trMemory; }
TR_PersistentMemory *trPersistentMemory() { return _trMemory->trPersistentMemory(); }
bool getOption(TR_CompilationOptions o) {return _options->getOption(o);}
void setOption(TR_CompilationOptions o) { _options->setOption(o); }
bool trace(OMR::Optimizations o) { return _options->trace(o); }
bool isDisabled(OMR::Optimizations o) { return _options->isDisabled(o); }
// Table of heap objects whose identity is known at compile-time
//
TR::KnownObjectTable *getKnownObjectTable() { return _knownObjectTable; }
TR::KnownObjectTable *getOrCreateKnownObjectTable();
void freeKnownObjectTable();
// Is this compilation producing relocatable code? This should generally
// return true, for example, for ahead-of-time compilations.
//
bool compileRelocatableCode() { return false; }
// Maximum number of internal pointers that can be managed.
//
int32_t maxInternalPointers();
// The OMR thread on which this compilation is occurring.
//
OMR_VMThread *omrVMThread() { return _omrVMThread; }
bool compilationShouldBeInterrupted(TR_CallingContext) { return false; }
/**
* @brief denotes the start of a region wherein decisions do not need to be
* remembered (for example, in relocatable compilations)
*/
void enterHeuristicRegion() {}
/**
* @brief denotes the end of a region wherein decisions do not need to be
* remembered (for example, in relocatable compilations)
*/
void exitHeuristicRegion() {}
/* Can be used to ensure that a implementer chosen for inlining is valid;
* for example, to ensure that the implementer can be used for inlining
* in a relocatable compilation
*/
bool validateTargetToBeInlined(TR_ResolvedMethod *implementer) { return true; }
// ..........................................................................
// Optimizer mechanics
int16_t getOptIndex() { return _currentOptIndex; }
void setOptIndex(int16_t i) { _currentOptIndex = i; }
void incOptIndex() { _currentOptIndex++; _currentOptSubIndex = 0; }
int32_t getOptSubIndex() { return _currentOptSubIndex; }
void incOptSubIndex() { _currentOptSubIndex++; }
void recordBegunOpt() { _lastBegunOptIndex = _currentOptIndex; }
void recordPerformedOptTransformation()
{
_lastPerformedOptIndex = _currentOptIndex;
_lastPerformedOptSubIndex = _currentOptSubIndex;
}
int16_t getLastBegunOptIndex() { return _lastBegunOptIndex; }
int16_t getLastPerformedOptIndex() { return _lastPerformedOptIndex; }
int32_t getLastPerformedOptSubIndex(){ return _lastPerformedOptSubIndex; }
bool isOutermostMethod();
bool ilGenTrace();
// ==========================================================================
// Debug
//
void setDebug(TR_Debug * d) { _debug = d; }
TR_Debug * getDebug() { return _debug; }
TR_Debug * findOrCreateDebug();
// Do not use the following directly; use diagnostic macro instead
void diagnosticImpl(const char *s, ...);
void diagnosticImplVA(const char *s, va_list ap);
// RAS methods.
TR::FILE *getOutFile() { return _options->getLogFile(); }
void setOutFile(TR::FILE *pf) { _options->setLogFile(pf); }
// --------------------------------------------------------------------------
bool allowRecompilation() {return _options->allowRecompilation();}
bool allocateAtThisOptLevel();
TR::Allocator allocator(const char *name = NULL) { return TR::Allocator(_allocator); }
TR_ArenaAllocator *arenaAllocator() { return &_arenaAllocator; }
void setAllocatorName(const char *name) { _allocatorName = name; }
TR_OpaqueMethodBlock *getMethodFromNode(TR::Node * node);
int32_t getLineNumber(TR::Node *);
int32_t getLineNumberInCurrentMethod(TR::Node * node);
bool useRegisterMaps();
bool suppressAllocationInlining() {return _options->getOption(TR_DisableAllocationInlining) || _options->getOption(TR_OptimizeForSpace);}
// ==========================================================================
// OMR utility
//
TR_IlGenerator *getCurrentIlGenerator() { return _ilGenerator; }
void setCurrentIlGenerator(TR_IlGenerator * il) { _ilGenerator = il; }
TR::Optimizer *getOptimizer() { return _optimizer; }
void setOptimizer(TR::Optimizer * o) { _optimizer = o; }
TR::ResolvedMethodSymbol *getMethodSymbol();
TR_ResolvedMethod *getCurrentMethod();
TR_ResolvedMethod *getMethodBeingCompiled() { return _method; }
TR::PersistentInfo *getPersistentInfo();
int32_t getCompThreadID() const { return _compThreadID; }
const char * signature() { return _signature; }
const char * externalName() { return _method->externalName(_trMemory); }
TR::ResolvedMethodSymbol *getJittedMethodSymbol() { return _methodSymbol;}
TR::CFG *getFlowGraph();
TR::TreeTop *getStartTree();
TR::TreeTop *findLastTree();
TR::Block *getStartBlock();
TR::Block * getCurrentBlock() {return _currentBlock;}
void setCurrentBlock(TR::Block * block) {_currentBlock=block; }
vcount_t getVisitCount();
vcount_t setVisitCount(vcount_t vc);
vcount_t incVisitCount();
void resetVisitCounts(vcount_t);
void resetVisitCounts(vcount_t, TR::TreeTop *);
vcount_t incOrResetVisitCount();
// common, compilation error code
int32_t getErrorCode() { return _errorCode; }
void setErrorCode(int32_t errorCode) { _errorCode = errorCode; }
TR::HCRMode getHCRMode();
// ==========================================================================
// Symbol reference
//
uint32_t getSymRefCount();
TR::SymbolReferenceTable *getSymRefTab()
{
if (_currentSymRefTab)
return _currentSymRefTab;
else
return _symRefTab;
}
void setCurrentSymRefTab(TR::SymbolReferenceTable *t) {_currentSymRefTab = t;}
TR::SymbolReferenceTable *getCurrentSymRefTab() {return _currentSymRefTab;}
// ==========================================================================
// Aliasing
//
int32_t getMaxAliasIndex();
// ==========================================================================
// Method
//
TR_ReturnInfo getReturnInfo() {return _returnInfo;}
void setReturnInfo(TR_ReturnInfo i);
mcount_t addOwningMethod(TR::ResolvedMethodSymbol * p);
TR::ResolvedMethodSymbol *getOwningMethodSymbol(mcount_t i);
TR::ResolvedMethodSymbol *getOwningMethodSymbol(TR_ResolvedMethod * method);
TR::ResolvedMethodSymbol *getOwningMethodSymbol(TR_OpaqueMethodBlock * method);
void registerResolvedMethodSymbolReference(TR::SymbolReference *);
TR::SymbolReference * getResolvedMethodSymbolReference(mcount_t index) { return _resolvedMethodSymbolReferences[index.value()]; }
bool isPeekingMethod();
// J9
void setContainsBigDecimalLoad(bool b) { _containsBigDecimalLoad = b; }
bool containsBigDecimalLoad() { return _containsBigDecimalLoad; }
bool osrStateIsReliable() { return _osrStateIsReliable;}
void setOsrStateIsReliable(bool b) { _osrStateIsReliable = b;}
bool osrInfrastructureRemoved() { return _osrInfrastructureRemoved; }
void setOSRInfrastructureRemoved(bool b) { _osrInfrastructureRemoved = b; }
bool mayHaveLoops();
bool hasLargeNumberOfLoops();
bool hasNews();
ToNumberMap &getToNumberMap() { return _toNumberMap; }
ToStringMap &getToStringMap() { return _toStringMap; }
ToCommentMap &getToCommentMap() { return _toCommentMap; }
/**
* @brief Answers whether a call to the provided resolved method would represent a
* recursive method call from the method currently being compiled.
*
* @param[in] targetResolvedMethod : the method symbol to check
*
* @return true if calling the targetResolvedMethod is a recursive call from the
* method being compiled; false otherwise.
*/
bool isRecursiveMethodTarget(TR_ResolvedMethod *targetResolvedMethod);
/**
* @brief Answers whether a call to the provided target symbol would represent a
* recursive method call from the method currently being compiled.
*
* @param[in] targetSymbol : the method symbol to check
*
* @return true if calling the targetSymbol is a recursive call from the method
* being compiled; false otherwise.
*/
bool isRecursiveMethodTarget(TR::Symbol *targetSymbol);
// ==========================================================================
// Should be in Code Generator
//
// J9
TR::list<TR::Instruction*> *getStaticPICSites() {return &_staticPICSites;}
TR::list<TR::Instruction*> *getStaticHCRPICSites() {return &_staticHCRPICSites;}
TR::list<TR::Instruction*> *getStaticMethodPICSites() {return &_staticMethodPICSites;}
bool isPICSite(TR::Instruction *instruction);
TR::list<TR::Snippet*> *getSnippetsToBePatchedOnClassUnload() { return &_snippetsToBePatchedOnClassUnload; }
TR::list<TR::Snippet*> *getMethodSnippetsToBePatchedOnClassUnload() { return &_methodSnippetsToBePatchedOnClassUnload; }
TR::list<TR::Snippet*> *getSnippetsToBePatchedOnClassRedefinition() { return &_snippetsToBePatchedOnClassRedefinition; }
TR_RegisterCandidates *getGlobalRegisterCandidates() { return _globalRegisterCandidates; }
void setGlobalRegisterCandidates(TR_RegisterCandidates *t) { _globalRegisterCandidates = t; }
bool hasNativeCall() { return _flags.testAny(HasNativeCall); }
void setHasNativeCall() { _flags.set(HasNativeCall); }
/*
* \brief
* This query tells whether the trees might contain rdbar/wrtbar opcodes
* that are not fully supported by optimizer yet
*
* \note
* This query is for temporarily fixing up unanchored rdbars or disable
* opts not supporting the newly added rdbar/wrtbar opcodes. Subprojects
* can override the answer. This query should be deleted eventually if
* all the optimizations support the opcodes.
*/
bool incompleteOptimizerSupportForReadWriteBarriers();
// P codegen
TR::list<TR_PrefetchInfo*> &getExtraPrefetchInfo() { return _extraPrefetchInfo; }
TR_PrefetchInfo *findExtraPrefetchInfo(TR::Node * node, bool use = true);
TR_PrefetchInfo *removeExtraPrefetchInfo(TR::Node * node);
// J9
// for TR_checkcastANDNullCHK
TR::list<TR_Pair<TR_ByteCodeInfo, TR::Node> *> &getCheckcastNullChkInfo() { return _checkcastNullChkInfo; }
// ==========================================================================
// Should be in Optimizer
//
// J9
bool getLoopWasVersionedWrtAsyncChecks() { return _loopVersionedWrtAsyncChecks; }
void setLoopWasVersionedWrtAsyncChecks(bool v) { _loopVersionedWrtAsyncChecks = v; }
// J9, used by VP to decide if a sync is needed at a monexit
bool syncsMarked() { return _flags.testAny(SyncsMarked); }
void setSyncsMarked() { _flags.set(SyncsMarked); }
void setLoopTransferDone() { _flags.set(LoopTransferDone); }
bool isLoopTransferDone() { return _flags.testAny(LoopTransferDone); }
// ..........................................................................
// Inliner
BitVectorPool& getBitVectorPool () { return _bitVectorPool; }
TR_Stack<int32_t> & getInlinedCallStack() {return _inlinedCallStack; }
uint16_t getInlineDepth() {return _inlinedCallStack.size();}
uint16_t getMaxInlineDepth() {return _maxInlineDepth;}
bool incInlineDepth(TR::ResolvedMethodSymbol *, TR::Node *callNode, bool directCall, TR_VirtualGuardSelection *guard, TR_OpaqueClassBlock *receiverClass, TR_PrexArgInfo *argInfo = 0);
bool incInlineDepth(TR::ResolvedMethodSymbol *, TR_ByteCodeInfo &, int32_t cpIndex, TR::SymbolReference *callSymRef, bool directCall, TR_PrexArgInfo *argInfo = 0);
bool incInlineDepth(TR_OpaqueMethodBlock *, TR::ResolvedMethodSymbol *, TR_ByteCodeInfo &, TR::SymbolReference *callSymRef, bool directCall, TR_PrexArgInfo *argInfo = 0);
void decInlineDepth(bool removeInlinedCallSitesEntries = false);
int16_t adjustInlineDepth(TR_ByteCodeInfo & bcInfo);
void resetInlineDepth();
int16_t restoreInlineDepth(TR_ByteCodeInfo &existingInfo);
int16_t matchingCallStackPrefixLength(TR_ByteCodeInfo &bcInfo);
bool foundOnTheStack(TR_ResolvedMethod *, int32_t);
int32_t getInlinedCalls() { return _inlinedCalls; }
void incInlinedCalls() { _inlinedCalls++; }
class TR_InlinedCallSiteInfo
{
TR_InlinedCallSite _site;
TR::ResolvedMethodSymbol *_resolvedMethod;
TR::SymbolReference *_callSymRef;
int32_t *_osrCallSiteRematTable;
bool _directCall;
bool _cannotAttemptOSRDuring;
public:
TR_InlinedCallSiteInfo(TR_OpaqueMethodBlock *methodInfo,
TR_ByteCodeInfo &bcInfo,
TR::ResolvedMethodSymbol *resolvedMethod,
TR::SymbolReference *callSymRef,
bool directCall):
_resolvedMethod(resolvedMethod), _callSymRef(callSymRef), _directCall(directCall), _osrCallSiteRematTable(0), _cannotAttemptOSRDuring(false)
{
_site._methodInfo = methodInfo;
_site._byteCodeInfo = bcInfo;
}
TR_InlinedCallSite &site() { return _site; }
TR_ResolvedMethod *resolvedMethod() { return _resolvedMethod->getResolvedMethod(); }
TR::ResolvedMethodSymbol *resolvedMethodSymbol() { return _resolvedMethod; }
TR::SymbolReference *callSymRef(){ return _callSymRef; }
int32_t *osrCallSiteRematTable() { return _osrCallSiteRematTable; }
void setOSRCallSiteRematTable(int32_t *array) { _osrCallSiteRematTable = array; }
bool directCall() { return _directCall; }
bool cannotAttemptOSRDuring() { return _cannotAttemptOSRDuring; }
void setCannotAttemptOSRDuring(bool cannotOSR) { _cannotAttemptOSRDuring = cannotOSR; }
};
uint32_t getNumInlinedCallSites();
TR_InlinedCallSite &getInlinedCallSite(uint32_t index);
TR_ResolvedMethod *getInlinedResolvedMethod(uint32_t index);
TR::ResolvedMethodSymbol *getInlinedResolvedMethodSymbol(uint32_t index);
TR::SymbolReference *getInlinedCallerSymRef(uint32_t index);
uint32_t getOSRCallSiteRematSize(uint32_t callSiteIndex);
void getOSRCallSiteRemat(uint32_t callSiteIndex, uint32_t slot, TR::SymbolReference *&ppSymRef, TR::SymbolReference *&loadSymRef);
void setOSRCallSiteRemat(uint32_t callSiteIndex, TR::SymbolReference *ppSymRef, TR::SymbolReference *loadSymRef);
bool isInlinedDirectCall(uint32_t index);
bool cannotAttemptOSRDuring(uint32_t index);
void setCannotAttemptOSRDuring(uint32_t index, bool cannot);
TR_InlinedCallSite *getCurrentInlinedCallSite();
int32_t getCurrentInlinedSiteIndex();
TR_PrexArgInfo *getCurrentInlinedCallArgInfo();
TR_Stack<TR_PrexArgInfo *>& getInlinedCallArgInfoStack();
void incNumLivePendingPushSlots(int32_t n) { _numLivePendingPushSlots = _numLivePendingPushSlots + n; }
int32_t getNumLivePendingPushSlots() { return _numLivePendingPushSlots; }
void incNumLoopNestingLevels(int32_t n) { _numNestingLevels = _numNestingLevels + n; }
int32_t getNumLoopNestingLevels() { return _numNestingLevels; }
//...........................................................................
// Peeking
TR_Stack<TR_PeekingArgInfo *> *getPeekingArgInfo();
TR_PeekingArgInfo *getCurrentPeekingArgInfo();
void addPeekingArgInfo(TR_PeekingArgInfo *info);
void removePeekingArgInfo();
TR::SymbolReferenceTable *getPeekingSymRefTab() { return _peekingSymRefTab; }
void setPeekingSymRefTab(TR::SymbolReferenceTable *symRefTab) { _peekingSymRefTab = symRefTab; }
int32_t getMaxPeekedBytecodeSize() const { return TR::Options::getMaxPeekedBytecodeSize() >> (_optimizationPlan->getReduceMaxPeekedBytecode());}
void AddCopyPropagationRematerializationCandidate(TR::SymbolReference * sr);
void RemoveCopyPropagationRematerializationCandidate(TR::SymbolReference * sr);
bool IsCopyPropagationRematerializationCandidate(TR::SymbolReference * sr);
// ==========================================================================
// RAS
//
int32_t getPrevSymRefTabSize() { return _prevSymRefTabSize; }
void setPrevSymRefTabSize( int32_t prevSize ) { _prevSymRefTabSize = prevSize; }
void dumpMethodTrees(char *title, TR::ResolvedMethodSymbol * = 0);
void dumpMethodTrees(char *title1, const char *title2, TR::ResolvedMethodSymbol * = 0);
void dumpFlowGraph( TR::CFG * = 0);
bool getAddressEnumerationOption(TR_CompilationOptions o) {return _options->getAddressEnumerationOption(o);}
TR::ILValidator *getILValidator() { return _ilValidator; }
void setILValidator(TR::ILValidator *ilValidator) { _ilValidator = ilValidator; }
void validateIL(TR::ILValidationContext ilValidationContext);
void verifyTrees(TR::ResolvedMethodSymbol *s = 0);
void verifyBlocks(TR::ResolvedMethodSymbol *s = 0);
void verifyCFG(TR::ResolvedMethodSymbol *s = 0);
/*
* \brief
* Check to make sure the rdbars are anchored and anchor a rdbar if it's found unanchored
*
* \note
* Ideally all optimizations should anchor a rdbar when it's created.
* This API is for fixing the unanchored rdbars in case some optimizations forget to
* anchor the node by mistake. Optimizations should still try to generate correct rdbar
* trees instead of relying on this API.
*/
void verifyAndFixRdbarAnchors();
void setIlVerifier(TR::IlVerifier *ilVerifier) { _ilVerifier = ilVerifier; }
typedef std::pair<const void * const, TR::DebugCounterBase *> DebugCounterEntry;
typedef TR::typed_allocator<DebugCounterEntry, TR::Allocator> DebugCounterMapAllocator;
typedef std::map<const void *, TR::DebugCounterBase *, std::less<const void *>, DebugCounterMapAllocator> DebugCounterMap;
/**
* @brief mapStaticAddressToCounter
* @param symRef the symref containing the static address of the memory used to
* store the count value of the debug counter
* @param counter pointer to the debug counter
*
* Maps the staticAddress of the symRef to the debug counter. The map has to be between the static address
* and the debug counter, instead of the symref of the static address and the debug counter, because sometimes,
* transformations can create a new symref that will not exist in this map; however because the static
* address is constant, it is guaranteed to exist in the map.
*/
void mapStaticAddressToCounter(TR::SymbolReference *symRef, TR::DebugCounterBase *counter);
/**
* @brief getCounterFromStaticAddress
* @param symRef the symref containingthe static address of the memory used to
* store the count value of the debug counter
* @return the debug counter associated with the static address
*/
TR::DebugCounterBase *getCounterFromStaticAddress(TR::SymbolReference *symRef);
#ifdef DEBUG
void dumpMethodGraph(int index, TR::ResolvedMethodSymbol * = 0);
#endif
int32_t getVerboseOptTransformationCount() { return _verboseOptTransformationCount; }
void incVerboseOptTransformationCount(int32_t delta=1) { _verboseOptTransformationCount += delta; }
int32_t getNodeOpCodeLength() { return _nodeOpCodeLength; }
void setNodeOpCodeLength( int32_t opCodeLen ) { _nodeOpCodeLength = opCodeLen; }
void incrNodeOpCodeLength( int32_t incr ) { _nodeOpCodeLength += incr; }
// ==========================================================================
// CHTable
//
TR_DevirtualizedCallInfo * getFirstDevirtualizedCall();
TR_DevirtualizedCallInfo * createDevirtualizedCall(TR::Node *,
TR_OpaqueClassBlock *);
TR_DevirtualizedCallInfo * findDevirtualizedCall(TR::Node *);
TR_DevirtualizedCallInfo * findOrCreateDevirtualizedCall(TR::Node *,
TR_OpaqueClassBlock *);
TR::list<TR_VirtualGuard*> &getVirtualGuards() { return _virtualGuards; }
TR_VirtualGuard *findVirtualGuardInfo(TR::Node *);
void addVirtualGuard (TR_VirtualGuard *guard);
void removeVirtualGuard(TR_VirtualGuard *guard);
TR::Node *createDummyOrSideEffectGuard(TR::Compilation *, int16_t, TR::Node *, TR::TreeTop *);
TR::Node *createSideEffectGuard(TR::Compilation *, TR::Node *, TR::TreeTop *);
TR::Node *createAOTInliningGuard(TR::Compilation *, int16_t, TR::Node *, TR::TreeTop *, TR_VirtualGuardKind);
TR::Node *createAOTGuard(TR::Compilation *, int16_t, TR::Node *, TR::TreeTop *, TR_VirtualGuardKind);
TR::Node *createDummyGuard(TR::Compilation *, int16_t, TR::Node *, TR::TreeTop *);
TR_LinkHead<TR_ClassLoadCheck> *getClassesThatShouldNotBeLoaded() { return &_classesThatShouldNotBeLoaded; }
TR_LinkHead<TR_ClassExtendCheck> *getClassesThatShouldNotBeNewlyExtended() { return &_classesThatShouldNotBeNewlyExtended;}
void setHasMethodOverrideAssumptions(bool v = true) { _flags.set(HasMethodOverrideAssumptions); }
bool hasMethodOverrideAssumptions() { return _flags.testAny(HasMethodOverrideAssumptions); }
void setHasClassExtendAssumptions(bool v = true) { _flags.set(HasClassExtendAssumptions); }
bool hasClassExtendAssumptions() { return _flags.testAny(HasClassExtendAssumptions); }
// ==========================================================================
// Compilation
//
int32_t compile();
static void shutdown(TR_FrontEnd *);
void performOptimizations();
bool isOptServer() const { return _isOptServer;}
bool isServerInlining() const { return _isServerInlining; }
bool isRecompilationEnabled() { return false; }
int32_t getOptLevel();
TR_Hotness getNextOptLevel() { return _nextOptLevel; }
void setNextOptLevel(TR_Hotness nextOptLevel) { _nextOptLevel = nextOptLevel; }
TR_Hotness getMethodHotness();
static const char *getHotnessName(TR_Hotness t);
const char *getHotnessName();
template<typename Exception>
void failCompilation(const char *format, ...)
{
char buffer[512];
va_list args;
va_start(args, format);
vsnprintf (buffer, sizeof(buffer), format, args);
va_end(args);
OMR::Compilation::reportFailure(buffer);
throw Exception();
}
void setOptimizationPlan(TR_OptimizationPlan *optimizationPlan ) {_optimizationPlan = optimizationPlan;}
TR_OptimizationPlan * getOptimizationPlan() {return _optimizationPlan;}
bool isProfilingCompilation();
ProfilingMode getProfilingMode();
bool isJProfilingCompilation();
TR::Recompilation *getRecompilationInfo() { return _recompilationInfo; }
void setRecompilationInfo(TR::Recompilation * i) { _recompilationInfo = i; }
/// Profiler info
/// @{
bool haveCommittedCallSiteInfo() { return _commitedCallSiteInfo; }
void setCommittedCallSiteInfo(bool b) { _commitedCallSiteInfo = b; }
/// @}
ncount_t getNodeCount();
ncount_t generateAccurateNodeCount();
ncount_t getAccurateNodeCount();
PhaseTimingSummary &phaseTimer() { return _phaseTimer; }
TR::PhaseMemSummary &phaseMemProfiler() { return _phaseMemProfiler; }
TR::NodePool &getNodePool() { return *_compilationNodes; }
bool mustNotBeRecompiled();
bool shouldBeRecompiled();
bool couldBeRecompiled();
bool hasBlockFrequencyInfo();
bool usesPreexistence() { return _usesPreexistence; }
void setUsesPreexistence(bool v);
bool hasUnsafeSymbol() { return _flags.testAny(HasUnsafeSymbol); }
void setHasUnsafeSymbol() { _flags.set(HasUnsafeSymbol); }
bool areSlotsSharedByRefAndNonRef() { return _flags.testAny(SlotsSharedByRefAndNonRef); }
void setSlotsSharedByRefAndNonRef(bool b) { _flags.set(SlotsSharedByRefAndNonRef, b); }
bool performVirtualGuardNOPing();
bool isVirtualGuardNOPingRequired(TR_VirtualGuard *virtualGuard = NULL);
// check if using compressed pointers
//
bool useCompressedPointers();
bool useAnchors();
void addGenILSym(TR::ResolvedMethodSymbol *s) { _genILSyms.push_front(s); }
// Arraylet availability in this compilation unit.
//
bool generateArraylets();
// Are spine checks for array element accesses required in this compilation unit.
//
bool requiresSpineChecks();
TR::list<TR_Pair<TR::Node, uint32_t> *> &getNodesThatShouldPrefetchOffset()
{ return _nodesThatShouldPrefetchOffset; }
int32_t findPrefetchInfo(TR::Node * node);
bool canTransformUnsafeCopyToArrayCopy();
bool canTransformUnsafeSetMemory();
bool supportsInduceOSR();
bool canAffordOSRControlFlow();
void setCanAffordOSRControlFlow(bool b) { _canAffordOSRControlFlow = b; }
bool penalizePredsOfOSRCatchBlocksInGRA();
/*
* Return true if the supplied method in the inlining table is known to not run
* for very long and so not require asyncchecks or other yields
*/
bool isShortRunningMethod(int32_t callerIndex);
/*
* isPotentialOSRPoint - used to check if a given treetop could be a point
* where we would make an OSR transition from the JIT'd code to the interpreter.
* Normal usage requires you to pass in a TreeTop and the transition node will
* be distilled from that. Supplying a node directly is a very special operation
* and is primarily intended for ILGen before blocks are created - you risk
* incorrect answers if you fail to supply the TreeTop.
*
* osrPointNode can be used to identify the node that is believed to be the
* potential OSR point. Multiple OSR points are not expected within a tree.
*
* The ignoreInfra flag will result in the call checking the node even if
* OSR infrastructure has been removed. By default, if infrastructure has been
* removed, this call will always return false.
*/
bool isPotentialOSRPoint(TR::Node *node, TR::Node **osrPointNode=NULL, bool ignoreInfra=false);
bool isPotentialOSRPointWithSupport(TR::TreeTop *tt);
TR::OSRMode getOSRMode();
TR::OSRTransitionTarget getOSRTransitionTarget();
bool isOSRTransitionTarget(TR::OSRTransitionTarget target);
int32_t getOSRInductionOffset(TR::Node *node);
bool requiresAnalysisOSRPoint(TR::Node *node);
bool pendingPushLivenessDuringIlgen();
// for OSR
TR_OSRCompilationData* getOSRCompilationData() {return _osrCompilationData;}
void setSeenClassPreventingInducedOSR();
// for assumptions Flags
void setHasClassUnloadAssumptions(bool v = true) { _flags.set(HasClassUnloadAssumptions); }
bool hasClassUnloadAssumptions() { return _flags.testAny(HasClassUnloadAssumptions); }
void setHasClassRedefinitionAssumptions(bool v = true) { _flags.set(HasClassRedefinitionAssumptions); }
bool hasClassRedefinitionAssumptions() { return _flags.testAny(HasClassRedefinitionAssumptions); }
void setHasClassPreInitializeAssumptions(bool v = true) { _flags.set(HasClassPreInitializeAssumptions); }
bool hasClassPreInitializeAssumptions() { return _flags.testAny(HasClassPreInitializeAssumptions); }
void setUsesBlockFrequencyInGRA() { _flags.set(UsesBlockFrequencyInGRA); }
bool getUsesBlockFrequencyInGRA() { return _flags.testAny(UsesBlockFrequencyInGRA); }
void setScratchSpaceLimit(size_t val) { _scratchSpaceLimit = val; }
size_t getScratchSpaceLimit() { return _scratchSpaceLimit; }
void setHasMethodHandleInvoke() { _flags.set(HasMethodHandleInvoke); }
bool getHasMethodHandleInvoke() { return _flags.testAny(HasMethodHandleInvoke); }
bool supressEarlyInlining() { return _noEarlyInline; }
void setSupressEarlyInlining(bool b) { _noEarlyInline = b; }
void setHasColdBlocks()
{
_flags.set(HasColdBlocks);
}
bool hasColdBlocks()
{
return _flags.testAny(HasColdBlocks);
}
/**
* @brief Specify that the code cache should only contain read only code.
*/
void setGenerateReadOnlyCode()
{
_flags.set(GenerateReadOnlyCode);
}
/**
* @brief Query whether the code cache should only contain read only code.
* @return true if generating read only code; false otherwise.
*/
bool getGenerateReadOnlyCode()
{
return _flags.testAny(GenerateReadOnlyCode);
}
TR::ResolvedMethodSymbol *createJittedMethodSymbol(TR_ResolvedMethod *resolvedMethod);
bool isGPUCompilation() { return _flags.testAny(IsGPUCompilation);}
#ifdef J9_PROJECT_SPECIFIC
bool hasIntStreamForEach() { return _flags.testAny(HasIntStreamForEach);}
void setHasIntStreamForEach() { _flags.set(HasIntStreamForEach); }