-
Notifications
You must be signed in to change notification settings - Fork 392
/
OMRIlBuilder.cpp
2939 lines (2543 loc) · 109 KB
/
OMRIlBuilder.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, 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
*******************************************************************************/
#include "env/TRMemory.hpp" // must precede IlBuilder.hpp to get TR_ALLOC
#include "ilgen/IlBuilder.hpp"
#include <stdint.h>
#include <stdarg.h>
#include <string.h>
#include "codegen/CodeGenerator.hpp"
#include "compile/Compilation.hpp"
#include "compile/Method.hpp"
#include "compile/SymbolReferenceTable.hpp"
#include "control/Recompilation.hpp"
#include "env/CompilerEnv.hpp"
#include "env/FrontEnd.hpp"
#include "il/AutomaticSymbol.hpp"
#include "il/Block.hpp"
#include "il/SymbolReference.hpp"
#include "il/ILOps.hpp"
#include "il/Node.hpp"
#include "il/Node_inlines.hpp"
#include "il/TreeTop.hpp"
#include "il/TreeTop_inlines.hpp"
#include "ilgen/IlGeneratorMethodDetails_inlines.hpp"
#include "ilgen/TypeDictionary.hpp"
#include "ilgen/IlInjector.hpp"
#include "ilgen/IlReference.hpp"
#include "ilgen/MethodBuilder.hpp"
#include "ilgen/BytecodeBuilder.hpp"
#include "infra/Cfg.hpp"
#include "infra/List.hpp"
#define OPT_DETAILS "O^O ILBLD: "
#define TraceEnabled (comp()->getOption(TR_TraceILGen))
#define TraceIL(m, ...) {if (TraceEnabled) {traceMsg(comp(), m, ##__VA_ARGS__);}}
// IlBuilder is a class designed to help build Testarossa IL quickly without
// a lot of knowledge of the intricacies of commoned references, symbols,
// symbol references, or blocks. You can add operations to an IlBuilder via
// a set of services, for example: Add, Sub, Load, Store. These services
// operate on TR::IlValues, which currently correspond to SymbolReferences.
// However, IlBuilders also incorporate a notion of "symbols" that are
// identified by strings (i.e. arbitrary symbolic names).
//
// So Load("a") returns a TR::IlValue. Load("b") returns a different
// TR::IlValue. The value of a+b can be computed by Add(Load("a"),Load("b")),
// and that value can be stored into c by Store("c", Add(Load("a"),Load("b"))).
//
// More complicated services exist to construct control flow by linking
// together sets of IlBuilder objects. A simple if-then construct, for
// example, can be built with the following code:
// TR::IlValue *condition = NotEqualToZero(Load("a"));
// TR::IlBuilder *then = NULL;
// IfThen(&then, condition);
// then->Return(then->ConstInt32(0));
//
//
// An IlBuilder is really a sequence of Blocks and other IlBuilders, but an
// IlBuilder is also a sequence of TreeTops connecting together a set of
// Blocks that are arranged in the CFG. Another way to think of an IlBuilder
// is as representing the code needed to execute a particular code path
// (which may itself have sub control flow handled by embedded IlBuilders).
// All IlBuilders exist within the single control flow graph, but the full
// control flow graph will not be connected together until all IlBuilder
// objects have had injectIL() called.
OMR::IlBuilder::IlBuilder(TR::IlBuilder *source)
: TR::IlInjector(source),
_client(0),
_clientCallbackBuildIL(0),
_methodBuilder(source->_methodBuilder),
_sequence(0),
_sequenceAppender(0),
_entryBlock(0),
_exitBlock(0),
_count(-1),
_partOfSequence(false),
_connectedTrees(false),
_comesBack(true)
{
}
bool
OMR::IlBuilder::TraceEnabled_log(){
bool traceEnabled = _comp->getOption(TR_TraceILGen);
return traceEnabled;
}
void
OMR::IlBuilder::TraceIL_log(const char* s, ...){
va_list argp;
va_start (argp, s);
traceMsgVarArgs(_comp, s, argp);
va_end(argp);
}
void
OMR::IlBuilder::initSequence()
{
_sequence = new (_comp->trMemory()->trHeapMemory()) List<SequenceEntry>(_comp->trMemory());
_sequenceAppender = new (_comp->trMemory()->trHeapMemory()) ListAppender<SequenceEntry>(_sequence);
}
bool
OMR::IlBuilder::injectIL()
{
TraceIL("Inside injectIL()\n");
TraceIL("original entry %p\n", cfg()->getStart());
TraceIL("original exit %p\n", cfg()->getEnd());
setupForBuildIL();
bool rc = buildIL();
TraceIL("buildIL() returned %d\n", rc);
if (!rc)
return false;
rc = connectTrees();
if (TraceEnabled)
comp()->dumpMethodTrees("after connectTrees");
cfg()->removeUnreachableBlocks();
if (TraceEnabled)
comp()->dumpMethodTrees("after removing unreachable blocks");
return rc;
}
void
OMR::IlBuilder::setupForBuildIL()
{
initSequence();
appendBlock(NULL, false);
_entryBlock = _currentBlock;
_exitBlock = emptyBlock();
}
void
OMR::IlBuilder::print(const char *title, bool recurse)
{
if (!TraceEnabled)
return;
if (title != NULL)
TraceIL("[ %p ] %s\n", this, title);
TraceIL("[ %p ] _methodBuilder %p\n", this, _methodBuilder);
TraceIL("[ %p ] _entryBlock %p\n", this, _entryBlock);
TraceIL("[ %p ] _exitBlock %p\n", this, _exitBlock);
TraceIL("[ %p ] _connectedBlocks %d\n", this, _connectedTrees);
TraceIL("[ %p ] _comesBack %d\n", this, _comesBack);
TraceIL("[ %p ] Sequence:\n", this);
ListIterator<SequenceEntry> iter(_sequence);
for (SequenceEntry *entry = iter.getFirst(); !iter.atEnd(); entry = iter.getNext())
{
if (entry->_isBlock)
{
printBlock(entry->_block);
}
else
{
if (recurse)
{
TraceIL("[ %p ] Inner builder %p", this, entry->_builder);
entry->_builder->print(NULL, recurse);
}
else
{
TraceIL("[ %p ] Builder %p\n", this, entry->_builder);
}
}
}
}
void
OMR::IlBuilder::printBlock(TR::Block *block)
{
if (!TraceEnabled)
return;
TraceIL("[ %p ] Block %p\n", this, block);
TR::TreeTop *tt = block->getEntry();
while (tt != block->getExit())
{
comp()->getDebug()->print(comp()->getOutFile(), tt);
tt = tt->getNextTreeTop();
}
comp()->getDebug()->print(comp()->getOutFile(), tt);
}
TR::SymbolReference *
OMR::IlBuilder::lookupSymbol(const char *name)
{
TR_ASSERT_FATAL(_methodBuilder, "cannot look up symbols in an IlBuilder that has no MethodBuilder");
return _methodBuilder->lookupSymbol(name);
}
void
OMR::IlBuilder::defineSymbol(const char *name, TR::SymbolReference *symRef)
{
TR_ASSERT_FATAL(_methodBuilder, "cannot define symbols in an IlBuilder that has no MethodBuilder");
_methodBuilder->defineSymbol(name, symRef);
}
void
OMR::IlBuilder::defineValue(const char *name, TR::IlType *type)
{
TR::DataType dt = type->getPrimitiveType();
TR::SymbolReference *newSymRef = symRefTab()->createTemporary(methodSymbol(), dt);
newSymRef->getSymbol()->setNotCollected();
defineSymbol(name, newSymRef);
}
TR::IlValue *
OMR::IlBuilder::newValue(TR::DataType dt, TR::Node *n)
{
// make sure TreeTop is well formed
TR::Node *ttNode = n;
if (!ttNode->getOpCode().isTreeTop())
ttNode = TR::Node::create(TR::treetop, 1, n);
TR::TreeTop *tt = TR::TreeTop::create(_comp, ttNode);
_currentBlock->append(tt);
TR::IlValue *value = new (_comp->trHeapMemory()) TR::IlValue(n, tt, _currentBlock, _methodBuilder);
return value;
}
TR::IlValue *
OMR::IlBuilder::newValue(TR::IlType *dt, TR::Node *n)
{
return newValue(dt->getPrimitiveType(), n);
}
TR::IlValue *
OMR::IlBuilder::NewValue(TR::IlType *dt)
{
TR_ASSERT_FATAL(0, "should not create a value without a TR::Node");
}
TR::IlValue *
OMR::IlBuilder::Copy(TR::IlValue *value)
{
TR::DataType dt = value->getDataType();
TR::SymbolReference *newSymRef = symRefTab()->createTemporary(_methodSymbol, dt);
char *name = (char *) _comp->trMemory()->allocateHeapMemory((2+10+1) * sizeof(char)); // 2 ("_T") + max 10 digits + trailing zero
sprintf(name, "_T%u", newSymRef->getCPIndex());
newSymRef->getSymbol()->getAutoSymbol()->setName(name);
newSymRef->getSymbol()->setNotCollected();
_methodBuilder->defineSymbol(name, newSymRef);
storeToTemp(newSymRef, loadValue(value));
TR::IlValue *newVal = newValue(newSymRef->getSymbol()->getDataType(), loadTemp(newSymRef));
TraceIL("IlBuilder[ %p ]::Copy value (%d) dataType (%d) to newVal (%d) at cpIndex (%d)\n", this, value->getID(), dt, newVal->getID(), newSymRef->getCPIndex());
return newVal;
}
TR::TreeTop *
OMR::IlBuilder::getFirstTree()
{
TR_ASSERT_FATAL(_blocks, "_blocks not created yet");
TR_ASSERT_FATAL(_blocks[0], "_blocks[0] not created yet");
return _blocks[0]->getEntry();
}
TR::TreeTop *
OMR::IlBuilder::getLastTree()
{
TR_ASSERT_FATAL(_blocks, "_blocks not created yet");
TR_ASSERT_FATAL(_blocks[_numBlocks], "_blocks[0] not created yet");
return _blocks[_numBlocks]->getExit();
}
uint32_t
OMR::IlBuilder::countBlocks()
{
// only count each block once
if (_count > -1)
return _count;
TraceIL("[ %p ] TR::IlBuilder::countBlocks 0 at entry\n", this);
_count = 0; // prevent recursive counting; will be updated to real value before returning
uint32_t count=0;
ListIterator<SequenceEntry> iter(_sequence);
for (SequenceEntry *entry = iter.getFirst(); !iter.atEnd(); entry = iter.getNext())
{
if (entry->_isBlock)
count++;
else
count += entry->_builder->countBlocks();
}
if (this != _methodBuilder || _methodBuilder->callerMethodBuilder() != NULL)
{
// exit block isn't in the sequence except for method builders
// gets tacked in late by connectTrees
count++;
}
TraceIL("[ %p ] TR::IlBuilder::countBlocks %d\n", this, count);
_count = count;
return count;
}
void
OMR::IlBuilder::pullInBuilderTrees(TR::IlBuilder *builder,
uint32_t *currentBlock,
TR::TreeTop **firstTree,
TR::TreeTop **newLastTree)
{
TraceIL("\n[ %p ] Calling connectTrees on inner builder %p\n", this, builder);
builder->connectTrees();
TraceIL("\n[ %p ] Returned from connectTrees on %p\n", this, builder);
TR::Block **innerBlocks = builder->blocks();
uint32_t innerNumBlocks = builder->numBlocks();
uint32_t copyBlock = *currentBlock;
for (uint32_t i=0;i < innerNumBlocks;i++, copyBlock++)
{
if (TraceEnabled)
{
TraceIL("[ %p ] copying inner block B%d to B%d\n", this, i, copyBlock);
printBlock(innerBlocks[i]);
}
_blocks[copyBlock] = innerBlocks[i];
}
*currentBlock += innerNumBlocks;
*firstTree = innerBlocks[0]->getEntry();
*newLastTree = innerBlocks[innerNumBlocks-1]->getExit();
}
bool
OMR::IlBuilder::connectTrees()
{
// don't do this more than once per builder object
if (_connectedTrees)
return true;
_connectedTrees = true;
TraceIL("[ %p ] TR::IlBuilder::connectTrees():\n", this);
// figure out how many blocks we need
uint32_t numBlocks = countBlocks();
TraceIL("[ %p ] Total %d blocks\n", this, numBlocks);
allocateBlocks(numBlocks);
TraceIL("[ %p ] Allocated _blocks %p\n", this, _blocks);
// now add all the blocks from the sequence into the _blocks array
// and connect the trees into a single sequence
uint32_t currentBlock = 0;
TR::Block **blocks = _blocks;
TR::TreeTop *lastTree = NULL;
TraceIL("[ %p ] Connecting trees one entry at a time:\n", this);
ListIterator<SequenceEntry> iter(_sequence);
for (SequenceEntry *entry = iter.getFirst(); !iter.atEnd(); entry = iter.getNext())
{
TraceIL("[ %p ] currentBlock = %d\n", this, currentBlock);
TraceIL("[ %p ] lastTree = %p\n", this, lastTree);
TR::TreeTop *firstTree = NULL;
TR::TreeTop *newLastTree = NULL;
if (entry->_isBlock)
{
if (TraceEnabled)
{
TraceIL("[ %p ] Block entry %p becomes block B%d\n", this, entry->_block, currentBlock);
printBlock(entry->_block);
}
blocks[currentBlock++] = entry->_block;
firstTree = entry->_block->getEntry();
newLastTree = entry->_block->getExit();
}
else
{
TR::IlBuilder *builder = entry->_builder;
pullInBuilderTrees(builder, ¤tBlock, &firstTree, &newLastTree);
}
TraceIL("[ %p ] First tree is %p [ node %p ]\n", this, firstTree, firstTree->getNode());
TraceIL("[ %p ] Last tree will be %p [ node %p ]\n", this, newLastTree, newLastTree->getNode());
// connect the trees
if (lastTree)
{
TraceIL("[ %p ] Connecting tree %p [ node %p ] to new tree %p [ node %p ]\n", this, lastTree, lastTree->getNode(), firstTree, firstTree->getNode());
lastTree->join(firstTree);
}
lastTree = newLastTree;
}
if (_methodBuilder != this || _methodBuilder->callerMethodBuilder() != NULL)
{
// non-method builders need to append the "EXIT" block trees
// (method builders have EXIT as the special block 1)
TraceIL("[ %p ] Connecting last tree %p [ node %p ] to exit block entry %p [ node %p ]\n", this, lastTree, lastTree->getNode(), _exitBlock->getEntry(), _exitBlock->getEntry()->getNode());
lastTree->join(_exitBlock->getEntry());
// also add exit block to blocks array and add an edge from last block to EXIT if the builder comes back (i.e. doesn't return or branch off somewhere)
if (comesBack())
cfg()->addEdge(blocks[currentBlock-1], getExit());
blocks[currentBlock++] = _exitBlock;
TraceIL("[ %p ] exit block %d is %p (%p -> %p)\n", this, _exitBlock->getNumber(), _exitBlock->getEntry(), _exitBlock->getExit());
lastTree = _exitBlock->getExit();
_numBlocks = currentBlock;
}
TraceIL("[ %p ] last tree %p [ node %p ]\n", this, lastTree, lastTree->getNode());
lastTree->setNextTreeTop(NULL);
TraceIL("[ %p ] blocks[%d] exit tree is %p\n", this, currentBlock-1, blocks[currentBlock-1]->getExit());
return true;
}
TR::Node *
OMR::IlBuilder::zero(TR::DataType dt)
{
switch (dt)
{
case TR::Int8 : return TR::Node::bconst(0);
case TR::Int16 : return TR::Node::sconst(0);
case TR::Int32 : return TR::Node::iconst(0);
case TR::Int64 : return TR::Node::lconst(0);
default : return TR::Node::create(TR::ILOpCode::constOpCode(dt), 0, 0);
}
TR_ASSERT_FATAL(0, "should not reach here");
}
TR::Node *
OMR::IlBuilder::zero(TR::IlType *dt)
{
return zero(dt->getPrimitiveType());
}
TR::Node *
OMR::IlBuilder::zeroNodeForValue(TR::IlValue *v)
{
return zero(v->getDataType());
}
TR::IlValue *
OMR::IlBuilder::zeroForValue(TR::IlValue *v)
{
TR::IlValue *returnValue = newValue(v->getDataType(), zeroNodeForValue(v));
return returnValue;
}
TR::IlBuilder *
OMR::IlBuilder::OrphanBuilder()
{
TR::IlBuilder *orphan = new (comp()->trHeapMemory()) TR::IlBuilder(_methodBuilder, _types);
orphan->initialize(_details, _methodSymbol, _fe, _symRefTab);
orphan->setupForBuildIL();
return orphan;
}
TR::BytecodeBuilder *
OMR::IlBuilder::OrphanBytecodeBuilder(int32_t bcIndex, char *name)
{
TR::BytecodeBuilder *orphan = new (comp()->trHeapMemory()) TR::BytecodeBuilder(_methodBuilder, bcIndex, name);
orphan->initialize(_details, _methodSymbol, _fe, _symRefTab);
orphan->setupForBuildIL();
return orphan;
}
TR::Block *
OMR::IlBuilder::emptyBlock()
{
TR::Block *empty = TR::Block::createEmptyBlock(NULL, _comp);
cfg()->addNode(empty);
return empty;
}
TR::IlBuilder *
OMR::IlBuilder::createBuilderIfNeeded(TR::IlBuilder *builder)
{
if (builder == NULL)
builder = OrphanBuilder();
return builder;
}
OMR::IlBuilder::SequenceEntry *
OMR::IlBuilder::blockEntry(TR::Block *block)
{
return new (_comp->trMemory()->trHeapMemory()) IlBuilder::SequenceEntry(block);
}
OMR::IlBuilder::SequenceEntry *
OMR::IlBuilder::builderEntry(TR::IlBuilder *builder)
{
return new (_comp->trMemory()->trHeapMemory()) IlBuilder::SequenceEntry(builder);
}
void
OMR::IlBuilder::appendBlock(TR::Block *newBlock, bool addEdge)
{
if (newBlock == NULL)
{
newBlock = emptyBlock();
}
_sequenceAppender->add(blockEntry(newBlock));
if (_currentBlock && addEdge)
{
// if current block does not fall through to new block, use appendNoFallThroughBlock() rather than appendBlock()
cfg()->addEdge(_currentBlock, newBlock);
}
// subsequent IL should generate to appended block
_currentBlock = newBlock;
}
void
OMR::IlBuilder::AppendBuilder(TR::IlBuilder *builder)
{
TR_ASSERT_FATAL(builder->_partOfSequence == false, "builder cannot be in two places");
builder->_partOfSequence = true;
_sequenceAppender->add(builderEntry(builder));
if (_currentBlock != NULL)
{
cfg()->addEdge(_currentBlock, builder->getEntry());
_currentBlock = NULL;
}
TraceIL("IlBuilder[ %p ]::AppendBuilder %p\n", this, builder);
// when trees are connected, exit block will swing down to become last trees in builder, so it can fall through to this block we're about to create
// need to add edge explicitly because of this exit block sleight of hand
appendNoFallThroughBlock();
cfg()->addEdge(builder->getExit(), _currentBlock);
}
TR::Node *
OMR::IlBuilder::loadValue(TR::IlValue *v)
{
return v->load(_currentBlock);
}
void
OMR::IlBuilder::storeNode(TR::SymbolReference *symRef, TR::Node *v)
{
genTreeTop(TR::Node::createStore(symRef, v));
}
void
OMR::IlBuilder::indirectStoreNode(TR::Node *addr, TR::Node *v)
{
TR::DataType dt = v->getDataType();
TR::SymbolReference *storeSymRef = symRefTab()->findOrCreateArrayShadowSymbolRef(dt, addr);
TR::ILOpCodes storeOp = comp()->il.opCodeForIndirectArrayStore(dt);
genTreeTop(TR::Node::createWithSymRef(storeOp, 2, addr, v, 0, storeSymRef));
}
TR::IlValue *
OMR::IlBuilder::indirectLoadNode(TR::IlType *dt, TR::Node *addr, bool isVectorLoad)
{
TR_ASSERT_FATAL(dt->isPointer(), "indirectLoadNode must apply to pointer type");
TR::IlType * baseType = dt->baseType();
TR::DataType primType = baseType->getPrimitiveType();
TR_ASSERT_FATAL(primType != TR::NoType, "Dereferencing an untyped pointer.");
TR::DataType symRefType = primType;
if (isVectorLoad)
symRefType = symRefType.scalarToVector();
TR::SymbolReference *storeSymRef = symRefTab()->findOrCreateArrayShadowSymbolRef(symRefType, addr);
TR::ILOpCodes loadOp = comp()->il.opCodeForIndirectArrayLoad(primType);
if (isVectorLoad)
{
loadOp = TR::ILOpCode::convertScalarToVector(loadOp);
baseType = _types->PrimitiveType(symRefType);
}
TR::Node *loadNode = TR::Node::createWithSymRef(loadOp, 1, 1, addr, storeSymRef);
TR::IlValue *loadValue = newValue(baseType, loadNode);
return loadValue;
}
/**
* @brief Store an IlValue into a named local variable
* @param varName the name of the local variable to be stored into. If the name has not been used before, this local variable will
* take the same data type as the value being written to it.
* @param value IlValue that should be written to the local variable, which should be the same data type
*/
void
OMR::IlBuilder::Store(const char *varName, TR::IlValue *value)
{
if (!_methodBuilder->symbolDefined(varName))
_methodBuilder->defineValue(varName, _types->PrimitiveType(value->getDataType()));
TR::SymbolReference *symRef = lookupSymbol(varName);
TraceIL("IlBuilder[ %p ]::Store %s %d (%d) gets %d\n", this, varName, symRef->getCPIndex(), symRef->getReferenceNumber(), value->getID());
storeNode(symRef, loadValue(value));
}
/**
* @brief Store an IlValue into the same local value as another IlValue
* @param dest IlValue that should now hold the same value as "value"
* @param value IlValue that should overwrite "dest"
*/
void
OMR::IlBuilder::StoreOver(TR::IlValue *dest, TR::IlValue *value)
{
TraceIL("IlBuilder[ %p ]::StoreOver %d gets %d\n", this, dest->getID(), value->getID());
dest->storeOver(value, _currentBlock);
}
/**
* @brief Store a vector IlValue into a named local variable
* @param varName the name of the local variable to be vector stored into. if the name has not been used before, this local variable will
* take the same data type as the value being written to it. The width of this data will be determined by the vector
* data type of IlValue.
* @param value IlValue with the vector data that should be written to the local variable, and should have the same data type
*/
void
OMR::IlBuilder::VectorStore(const char *varName, TR::IlValue *value)
{
TR::Node *valueNode = loadValue(value);
TR::DataType dt = valueNode->getDataType();
if (!dt.isVector())
{
valueNode = TR::Node::create(TR::vsplats, 1, valueNode);
dt = dt.scalarToVector();
}
if (!_methodBuilder->symbolDefined(varName))
_methodBuilder->defineValue(varName, _types->PrimitiveType(dt));
TR::SymbolReference *symRef = lookupSymbol(varName);
TraceIL("IlBuilder[ %p ]::VectorStore %s %d gets %d\n", this, varName, symRef->getCPIndex(), value->getID());
storeNode(symRef, valueNode);
}
/**
* @brief Store an IlValue through a pointer
* @param address the pointer address through which the value will be written
* @param value IlValue that should be written at "address"
*/
void
OMR::IlBuilder::StoreAt(TR::IlValue *address, TR::IlValue *value)
{
TR_ASSERT_FATAL(address->getDataType() == TR::Address, "StoreAt needs an address operand");
TraceIL("IlBuilder[ %p ]::StoreAt address %d gets %d\n", this, address->getID(), value->getID());
indirectStoreNode(loadValue(address), loadValue(value));
}
/**
* @brief Store a vector IlValue through a pointer
* @param address the pointer address through which the vector value will be written. The width of the store will be determined
* by the vector data type of IlValue.
* @param value IlValue with the vector data that should be written at "address"
*/
void
OMR::IlBuilder::VectorStoreAt(TR::IlValue *address, TR::IlValue *value)
{
TR_ASSERT_FATAL(address->getDataType() == TR::Address, "VectorStoreAt needs an address operand");
TraceIL("IlBuilder[ %p ]::VectorStoreAt address %d gets %d\n", this, address->getID(), value->getID());
TR::Node *valueNode = loadValue(value);
if (!valueNode->getDataType().isVector())
valueNode = TR::Node::create(TR::vsplats, 1, valueNode);
indirectStoreNode(loadValue(address), valueNode);
}
TR::IlValue *
OMR::IlBuilder::CreateLocalArray(int32_t numElements, TR::IlType *elementType)
{
uint32_t size = static_cast<uint32_t>(numElements * elementType->getSize());
TR::SymbolReference *localArraySymRef = symRefTab()->createLocalPrimArray(size,
methodSymbol(),
8 /*FIXME: JVM-specific - byte*/);
char *name = (char *) _comp->trMemory()->allocateHeapMemory((2+10+1) * sizeof(char)); // 2 ("_T") + max 10 digits + trailing zero
sprintf(name, "_T%u", localArraySymRef->getCPIndex());
localArraySymRef->getSymbol()->getAutoSymbol()->setName(name);
localArraySymRef->setStackAllocatedArrayAccess();
_methodBuilder->defineSymbol(name, localArraySymRef);
TR::Node *arrayAddress = TR::Node::createWithSymRef(TR::loadaddr, 0, localArraySymRef);
TR::IlValue *arrayAddressValue = newValue(TR::Address, arrayAddress);
TraceIL("IlBuilder[ %p ]::CreateLocalArray array allocated %d bytes, address in %d\n", this, size, arrayAddressValue->getID());
return arrayAddressValue;
}
TR::IlValue *
OMR::IlBuilder::CreateLocalStruct(TR::IlType *structType)
{
//similar to CreateLocalArray except writing a method in StructType to get the struct size
uint32_t size = static_cast<uint32_t>(structType->getSize());
TR::SymbolReference *localStructSymRef = symRefTab()->createLocalPrimArray(size,
methodSymbol(),
8 /*FIXME: JVM-specific - byte*/);
char *name = (char *) _comp->trMemory()->allocateHeapMemory((2+10+1) * sizeof(char)); // 2 ("_T") + max 10 digits + trailing zero
sprintf(name, "_T%u", localStructSymRef->getCPIndex());
localStructSymRef->getSymbol()->getAutoSymbol()->setName(name);
localStructSymRef->setStackAllocatedArrayAccess();
_methodBuilder->defineSymbol(name, localStructSymRef);
TR::Node *structAddress = TR::Node::createWithSymRef(TR::loadaddr, 0, localStructSymRef);
TR::IlValue *structAddressValue = newValue(TR::Address, structAddress);
TraceIL("IlBuilder[ %p ]::CreateLocalStruct struct allocated %d bytes, address in %d\n", this, size, structAddressValue->getID());
return structAddressValue;
}
void
OMR::IlBuilder::StoreIndirect(const char *type, const char *field, TR::IlValue *object, TR::IlValue *value)
{
TR::IlReference *fieldRef = _types->FieldReference(type, field);
TR::SymbolReference *symRef = fieldRef->symRef();
TR::DataType fieldType = symRef->getSymbol()->getDataType();
TraceIL("IlBuilder[ %p ]::StoreIndirect %s.%s (%d) into (%d)\n", this, type, field, value->getID(), object->getID());
TR::ILOpCodes storeOp = comp()->il.opCodeForIndirectStore(fieldType);
genTreeTop(TR::Node::createWithSymRef(storeOp, 2, loadValue(object), loadValue(value), 0, symRef));
}
TR::IlValue *
OMR::IlBuilder::Load(const char *name)
{
TR::SymbolReference *symRef = lookupSymbol(name);
TR::Node *valueNode = TR::Node::createLoad(symRef);
TR::IlValue *returnValue = newValue(symRef->getSymbol()->getDataType(), valueNode);
TraceIL("IlBuilder[ %p ]::Load %s into %d from symref %d\n", this, name, returnValue->getID(), symRef->getReferenceNumber());
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::VectorLoad(const char *name)
{
TR::SymbolReference *nameSymRef = lookupSymbol(name);
TR::DataType returnType = nameSymRef->getSymbol()->getDataType();
TR_ASSERT_FATAL(returnType.isVector(), "VectorLoad must load symbol with a vector type");
TR::Node *loadNode = TR::Node::createWithSymRef(0, TR::comp()->il.opCodeForDirectLoad(returnType), 0, nameSymRef);
TR::IlValue *returnValue = newValue(returnType, loadNode);
TraceIL("IlBuilder[ %p ]::%d is VectorLoad %s (%d)\n", this, returnValue->getID(), name, nameSymRef->getCPIndex());
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::LoadIndirect(const char *type, const char *field, TR::IlValue *object)
{
TR::IlReference *fieldRef = _types->FieldReference(type, field);
TR::SymbolReference *symRef = fieldRef->symRef();
TR::DataType fieldType = symRef->getSymbol()->getDataType();
TR::IlValue *returnValue = newValue(fieldType, TR::Node::createWithSymRef(comp()->il.opCodeForIndirectLoad(fieldType), 1, loadValue(object), 0, symRef));
TraceIL("IlBuilder[ %p ]::%d is LoadIndirect %s.%s from (%d)\n", this, returnValue->getID(), type, field, object->getID());
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::LoadAt(TR::IlType *dt, TR::IlValue *address)
{
TR_ASSERT_FATAL(address->getDataType() == TR::Address, "LoadAt needs an address operand");
TR::IlValue *returnValue = indirectLoadNode(dt, loadValue(address));
TraceIL("IlBuilder[ %p ]::%d is LoadAt type %d address %d\n", this, returnValue->getID(), dt->getPrimitiveType(), address->getID());
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::VectorLoadAt(TR::IlType *dt, TR::IlValue *address)
{
TR_ASSERT_FATAL(address->getDataType() == TR::Address, "LoadAt needs an address operand");
TR::IlValue *returnValue = indirectLoadNode(dt, loadValue(address), true);
TraceIL("IlBuilder[ %p ]::%d is VectorLoadAt type %d address %d\n", this, returnValue->getID(), dt->getPrimitiveType(), address->getID());
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::IndexAt(TR::IlType *dt, TR::IlValue *base, TR::IlValue *index)
{
TR::IlType *elemType = dt->baseType();
TR_ASSERT_FATAL(base->getDataType() == TR::Address, "IndexAt must be called with a pointer base");
TR_ASSERT_FATAL(elemType != NULL, "IndexAt should be called with pointer type");
TR_ASSERT_FATAL(elemType->getPrimitiveType() != TR::NoType, "Cannot use IndexAt with pointer to NoType.");
TR::Node *baseNode = loadValue(base);
TR::Node *indexNode = loadValue(index);
TR::Node *elemSizeNode;
TR::ILOpCodes addOp, mulOp;
TR::DataType indexType = indexNode->getDataType();
if (TR::Compiler->target.is64Bit())
{
if (indexType != TR::Int64)
{
TR::ILOpCodes op = TR::DataType::getDataTypeConversion(indexType, TR::Int64);
indexNode = TR::Node::create(op, 1, indexNode);
}
elemSizeNode = TR::Node::lconst(elemType->getSize());
addOp = TR::aladd;
mulOp = TR::lmul;
}
else
{
TR::DataType targetType = TR::Int32;
if (indexType != targetType)
{
TR::ILOpCodes op = TR::DataType::getDataTypeConversion(indexType, targetType);
indexNode = TR::Node::create(op, 1, indexNode);
}
elemSizeNode = TR::Node::iconst(static_cast<int32_t>(elemType->getSize()));
addOp = TR::aiadd;
mulOp = TR::imul;
}
TR::Node *offsetNode = TR::Node::create(mulOp, 2, indexNode, elemSizeNode);
TR::Node *addrNode = TR::Node::create(addOp, 2, baseNode, offsetNode);
TR::IlValue *address = newValue(Address, addrNode);
TraceIL("IlBuilder[ %p ]::%d is IndexAt(%s) base %d index %d\n", this, address->getID(), dt->getName(), base->getID(), index->getID());
return address;
}
/**
* @brief Generate IL to load the address of a struct field.
*
* The address of the field is calculated by adding the field's offset to the
* base address of the struct. The address is also converted (type casted) to
* a pointer to the type of the field.
*/
TR::IlValue *
OMR::IlBuilder::StructFieldInstanceAddress(const char* structName, const char* fieldName, TR::IlValue* obj) {
auto offset = typeDictionary()->OffsetOf(structName, fieldName);
auto ptype = typeDictionary()->PointerTo(typeDictionary()->GetFieldType(structName, fieldName));
TR::IlValue* offsetValue = NULL;
if (TR::Compiler->target.is64Bit())
{
offsetValue = ConstInt64(offset);
}
else
{
offsetValue = ConstInt32(static_cast<int32_t>(offset));
}
auto addr = Add(obj, offsetValue);
return ConvertTo(ptype, addr);
}
/**
* @brief Generate IL to load the address of a union field.
*
* The address of the field is simply the base address of the union, since the
* offset of all union fields is zero.
*/
TR::IlValue *
OMR::IlBuilder::UnionFieldInstanceAddress(const char* unionName, const char* fieldName, TR::IlValue* obj) {
auto ptype = typeDictionary()->PointerTo(typeDictionary()->UnionFieldType(unionName, fieldName));
return ConvertTo(ptype, obj);
}
TR::IlValue *
OMR::IlBuilder::NullAddress()
{
TR::IlValue *returnValue = newValue(Address, TR::Node::aconst(0));
TraceIL("IlBuilder[ %p ]::%d is NullAddress\n", this, returnValue->getID());
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::ConstInt8(int8_t value)
{
TR::IlValue *returnValue = newValue(Int8, TR::Node::bconst(value));
TraceIL("IlBuilder[ %p ]::%d is ConstInt8 %d\n", this, returnValue->getID(), value);
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::ConstInt16(int16_t value)
{
TR::IlValue *returnValue = newValue(Int16, TR::Node::sconst(value));
TraceIL("IlBuilder[ %p ]::%d is ConstInt16 %d\n", this, returnValue->getID(), value);
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::ConstInt32(int32_t value)
{
TR::IlValue *returnValue = newValue(Int32, TR::Node::iconst(value));
TraceIL("IlBuilder[ %p ]::%d is ConstInt32 %d\n", this, returnValue->getID(), value);
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::ConstInt64(int64_t value)
{
TR::IlValue *returnValue = newValue(Int64, TR::Node::lconst(value));
TraceIL("IlBuilder[ %p ]::%d is ConstInt64 %lld\n", this, returnValue->getID(), value);
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::ConstFloat(float value)
{
TR::Node *fconstNode = TR::Node::create(0, TR::fconst, 0);
fconstNode->setFloat(value);
TR::IlValue *returnValue = newValue(Float, fconstNode);
TraceIL("IlBuilder[ %p ]::%d is ConstFloat %f\n", this, returnValue->getID(), value);
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::ConstDouble(double value)
{
TR::Node *dconstNode = TR::Node::create(0, TR::dconst, 0);
dconstNode->setDouble(value);
TR::IlValue *returnValue = newValue(Double, dconstNode);
TraceIL("IlBuilder[ %p ]::%d is ConstDouble %lf\n", this, returnValue->getID(), value);
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::ConstString(const char * const value)
{
TR::IlValue *returnValue = newValue(Address, TR::Node::aconst((uintptr_t)value));
TraceIL("IlBuilder[ %p ]::%d is ConstString %p\n", this, returnValue->getID(), value);
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::ConstAddress(const void * const value)
{
TR::IlValue *returnValue = newValue(Address, TR::Node::aconst((uintptr_t)value));
TraceIL("IlBuilder[ %p ]::%d is ConstAddress %p\n", this, returnValue->getID(), value);
return returnValue;
}
TR::IlValue *
OMR::IlBuilder::ConstInteger(TR::IlType *intType, int64_t value)
{
if (intType == Int8) return ConstInt8 ((int8_t) value);
else if (intType == Int16) return ConstInt16((int16_t) value);
else if (intType == Int32) return ConstInt32((int32_t) value);
else if (intType == Int64) return ConstInt64( value);
TR_ASSERT_FATAL(0, "unknown integer type");
return NULL;
}
TR::IlValue *
OMR::IlBuilder::ConvertTo(TR::IlType *t, TR::IlValue *v)
{
TR::DataType typeFrom = v->getDataType();
TR::DataType typeTo = t->getPrimitiveType();
if (typeFrom == typeTo)
{
TraceIL("IlBuilder[ %p ]::%d is ConvertTo (already has type %s) %d\n", this, v->getID(), t->getName(), v->getID());
return v;
}
TR::IlValue *convertedValue = convertTo(typeTo, v, false);
TraceIL("IlBuilder[ %p ]::%d is ConvertTo(%s) %d\n", this, convertedValue->getID(), t->getName(), v->getID());
return convertedValue;
}
TR::IlValue *
OMR::IlBuilder::UnsignedConvertTo(TR::IlType *t, TR::IlValue *v)
{
TR::DataType typeFrom = v->getDataType();
TR::DataType typeTo = t->getPrimitiveType();
if (typeFrom == typeTo)