-
Notifications
You must be signed in to change notification settings - Fork 393
/
ARM64Instruction.hpp
3933 lines (3572 loc) · 127 KB
/
ARM64Instruction.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) 2018, 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 ARM64INSTRUCTION_INCL
#define ARM64INSTRUCTION_INCL
#include <stddef.h>
#include <stdint.h>
#include "codegen/ARM64ConditionCode.hpp"
#include "codegen/ARM64ShiftCode.hpp"
#include "codegen/CodeGenerator.hpp"
#include "codegen/Instruction.hpp"
#include "codegen/MemoryReference.hpp"
#include "codegen/RegisterDependency.hpp"
#include "codegen/UnresolvedDataSnippet.hpp"
#include "il/LabelSymbol.hpp"
#include "infra/Assert.hpp"
class TR_VirtualGuardSite;
namespace TR { class SymbolReference; }
#define ARM64_INSTRUCTION_LENGTH 4
/*
* @brief Answers if the signed integer value can be placed in 7-bit field
* @param[in] intValue : signed integer value
* @return true if the value can be placed in 7-bit field, false otherwise
*/
inline bool constantIsImm7(int32_t intValue)
{
return (-64 <= intValue && intValue < 64);
}
/*
* @brief Answers if the signed integer value can be placed in 9-bit field
* @param[in] intValue : signed integer value
* @return true if the value can be placed in 9-bit field, false otherwise
*/
inline bool constantIsImm9(int32_t intValue)
{
return (-256 <= intValue && intValue < 256);
}
/*
* @brief Answers if the unsigned integer value can be encoded in a 4-bit field
* @param[in] intValue : unsigned integer value
* @return true if the value can be encoded in a 4-bit field, false otherwise
*/
inline bool constantIsUnsignedImm4(uint64_t intValue)
{
return (intValue < (1<<4)); // 16
}
/*
* @brief Answers if the unsigned integer value can be encoded in a 12-bit field
* @param[in] intValue : unsigned integer value
* @return true if the value can be encoded in a 12-bit field, false otherwise
*/
inline bool constantIsUnsignedImm12(uint64_t intValue)
{
return (intValue < (1<<12)); // 4096
}
/*
* @brief Answers if the unsigned integer value can be encoded in a 16-bit field
* @param[in] intValue : unsigned integer value
* @return true if the value can be encoded in a 16-bit field, false otherwise
*/
inline bool constantIsUnsignedImm16(uint64_t intValue)
{
return (intValue < (1<<16)); // 65536
}
/*
* @brief Answers if the signed integer value can be placed in 21-bit field
* @param[in] intValue : signed integer value
* @return true if the value can be placed in 21-bit field, false otherwise
*/
inline bool constantIsSignedImm21(intptr_t intValue)
{
return (-0x100000 <= intValue && intValue < 0x100000);
}
/*
* @brief Answers if the signed integer value can be placed in 28-bit field
* @param[in] intValue : signed integer value
* @return true if the value can be placed in 28-bit field, false otherwise
*/
inline bool constantIsSignedImm28(intptr_t intValue)
{
return (-0x8000000 <= intValue && intValue < 0x8000000);
}
namespace TR
{
class ARM64ImmInstruction : public TR::Instruction
{
uint32_t _sourceImmediate;
public:
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] imm : immediate value
* @param[in] cg : CodeGenerator
*/
ARM64ImmInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, uint32_t imm, TR::CodeGenerator *cg)
: TR::Instruction(op, node, cg), _sourceImmediate(imm)
{
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] imm : immediate value
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64ImmInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, uint32_t imm,
TR::Instruction *precedingInstruction, TR::CodeGenerator *cg)
: TR::Instruction(op, node, precedingInstruction, cg), _sourceImmediate(imm)
{
}
/**
* @brief Gets instruction kind
* @return instruction kind
*/
virtual Kind getKind() { return IsImm; }
/**
* @brief Gets source immediate
* @return source immediate
*/
uint32_t getSourceImmediate() {return _sourceImmediate;}
/**
* @brief Sets source immediate
* @param[in] si : immediate value
* @return source immediate
*/
uint32_t setSourceImmediate(uint32_t si) {return (_sourceImmediate = si);}
/**
* @brief Encodes the immediate value into the instruction
* @param[in] instruction : instruction address
*/
virtual void insertImmediateField(uint32_t *instruction)
{
// Write the 32-bit immediate with no masking or shifting.
// Be aware this will overwrite the entire 32-bit instruction
// with the immediate value.
//
*instruction = _sourceImmediate;
}
/**
* @brief Generates binary encoding of the instruction
* @return instruction cursor
*/
virtual uint8_t *generateBinaryEncoding();
};
class ARM64RelocatableImmInstruction : public TR::Instruction
{
uintptr_t _sourceImmediate;
TR_ExternalRelocationTargetKind _reloKind;
TR::SymbolReference *_symbolReference;
public:
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] imm : immediate value
* @param[in] relocationKind : relocation kind
* @param[in] cg : CodeGenerator
*/
ARM64RelocatableImmInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, uintptr_t imm,
TR_ExternalRelocationTargetKind relocationKind, TR::CodeGenerator *cg)
: TR::Instruction(op, node, cg),
_sourceImmediate(imm), _reloKind(relocationKind), _symbolReference(NULL)
{
setNeedsAOTRelocation();
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] imm : immediate value
* @param[in] relocationKind : relocation kind
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64RelocatableImmInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, uintptr_t imm,
TR_ExternalRelocationTargetKind relocationKind, TR::Instruction *precedingInstruction,
TR::CodeGenerator *cg)
: TR::Instruction(op, node, precedingInstruction, cg),
_sourceImmediate(imm), _reloKind(relocationKind), _symbolReference(NULL)
{
setNeedsAOTRelocation();
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] imm : immediate value
* @param[in] relocationKind : relocation kind
* @param[in] sr : symbol reference
* @param[in] cg : CodeGenerator
*/
ARM64RelocatableImmInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, uintptr_t imm,
TR_ExternalRelocationTargetKind relocationKind, TR::SymbolReference *sr,
TR::CodeGenerator *cg)
: TR::Instruction(op, node, cg),
_sourceImmediate(imm), _reloKind(relocationKind), _symbolReference(sr)
{
setNeedsAOTRelocation();
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] imm : immediate value
* @param[in] relocationKind : relocation kind
* @param[in] sr : symbol reference
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64RelocatableImmInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, uintptr_t imm,
TR_ExternalRelocationTargetKind relocationKind, TR::SymbolReference *sr,
TR::Instruction *precedingInstruction, TR::CodeGenerator *cg)
: TR::Instruction(op, node, precedingInstruction, cg),
_sourceImmediate(imm), _reloKind(relocationKind), _symbolReference(sr)
{
setNeedsAOTRelocation();
}
/**
* @brief Gets instruction kind
* @return instruction kind
*/
virtual Kind getKind() { return IsRelocatableImm; }
/**
* @brief Gets source immediate
* @return source immediate
*/
uintptr_t getSourceImmediate() {return _sourceImmediate;}
/**
* @brief Sets source immediate
* @param[in] si : immediate value
* @return source immediate
*/
uintptr_t setSourceImmediate(intptr_t si) {return (_sourceImmediate = si);}
/**
* @brief Encodes the immediate value into the instruction
* @param[in] instruction : instruction address
*/
void insertImmediateField(uintptr_t *instruction)
{
*instruction = _sourceImmediate;
}
/**
* @brief Sets relocation kind
* @param[in] reloKind : relocation kind
* @return relocation kind
*/
TR_ExternalRelocationTargetKind setReloKind(TR_ExternalRelocationTargetKind reloKind) { return (_reloKind = reloKind); }
/**
* @brief Gets relocation kind
* @return relocation kind
*/
TR_ExternalRelocationTargetKind getReloKind() { return _reloKind; }
/**
* @brief Sets symbol reference
* @param[in] sr : symbol reference
* @return symbol reference
*/
TR::SymbolReference *setSymbolReference(TR::SymbolReference *sr) { return (_symbolReference = sr); }
/**
* @brief Gets symbol reference
* @return symbol reference
*/
TR::SymbolReference *getSymbolReference() { return _symbolReference; }
/**
* @brief Generates binary encoding of the instruction
* @return instruction cursor
*/
virtual uint8_t *generateBinaryEncoding();
/**
* @brief Estimates binary length
* @param[in] currentEstimate : current estimated length
* @return estimated binary length
*/
virtual int32_t estimateBinaryLength(int32_t currentEstimate);
};
class ARM64ImmSymInstruction : public TR::Instruction
{
uintptr_t _addrImmediate;
TR::SymbolReference *_symbolReference;
TR::Snippet *_snippet;
public:
ARM64ImmSymInstruction(TR::InstOpCode::Mnemonic op,
TR::Node *node,
uintptr_t imm,
TR::RegisterDependencyConditions *cond,
TR::SymbolReference *sr,
TR::Snippet *s,
TR::CodeGenerator *cg)
: TR::Instruction(op, node, cond, cg),
_addrImmediate(imm), _symbolReference(sr), _snippet(s)
{
}
ARM64ImmSymInstruction(TR::InstOpCode::Mnemonic op,
TR::Node *node,
uintptr_t imm,
TR::RegisterDependencyConditions *cond,
TR::SymbolReference *sr,
TR::Snippet *s,
TR::Instruction *precedingInstruction,
TR::CodeGenerator *cg)
: TR::Instruction(op, node, cond, precedingInstruction, cg),
_addrImmediate(imm), _symbolReference(sr), _snippet(s)
{
}
/**
* @brief Gets instruction kind
* @return instruction kind
*/
virtual Kind getKind() { return IsImmSym; }
/**
* @brief Gets address immediate
* @return address immediate
*/
uintptr_t getAddrImmediate() { return _addrImmediate; }
/**
* @brief Sets address immediate
* @param[in] imm : address immediate
* @return address immediate
*/
uintptr_t setAddrImmediate(uintptr_t imm) { return (_addrImmediate = imm); }
/**
* @brief Gets symbol reference
* @return symbol reference
*/
TR::SymbolReference *getSymbolReference() { return _symbolReference; }
/**
* @brief Sets symbol reference
* @param[in] sr : symbol reference
* @return symbol reference
*/
TR::SymbolReference *setSymbolReference(TR::SymbolReference *sr)
{
return (_symbolReference = sr);
}
/**
* @brief Gets call snippet
* @return call snippet
*/
TR::Snippet *getCallSnippet() { return _snippet;}
/**
* @brief Sets call snippet
* @param[in] s : call snippet
* @return call snippet
*/
TR::Snippet *setCallSnippet(TR::Snippet *s) { return (_snippet = s); }
virtual TR::Snippet *getSnippetForGC() {return _snippet;}
/**
* @brief Sets immediate field in binary encoding
* @param[in] instruction : instruction cursor
* @param[in] distance : branch distance
*/
void insertImmediateField(uint32_t *instruction, int32_t distance)
{
TR_ASSERT((distance & 0x3) == 0, "branch distance is not aligned");
*instruction |= ((distance >> 2) & 0x3ffffff); // imm26
}
/**
* @brief Generates binary encoding of the instruction
* @return instruction cursor
*/
virtual uint8_t *generateBinaryEncoding();
};
class ARM64LabelInstruction : public TR::Instruction
{
TR::LabelSymbol *_symbol;
public:
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sym : label symbol
* @param[in] cg : CodeGenerator
*/
ARM64LabelInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::LabelSymbol *sym, TR::CodeGenerator *cg)
: TR::Instruction(op, node, cg), _symbol(sym)
{
if (sym != NULL && op == TR::InstOpCode::label)
sym->setInstruction(this);
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sym : label symbol
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64LabelInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::LabelSymbol *sym,
TR::Instruction *precedingInstruction, TR::CodeGenerator *cg)
: TR::Instruction(op, node, precedingInstruction, cg), _symbol(sym)
{
if (sym!=NULL && op==TR::InstOpCode::label)
sym->setInstruction(this);
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sym : label symbol
* @param[in] cond : register dependency condition
* @param[in] cg : CodeGenerator
*/
ARM64LabelInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::LabelSymbol *sym,
TR::RegisterDependencyConditions *cond, TR::CodeGenerator *cg)
: TR::Instruction(op, node, cond, cg), _symbol(sym)
{
if (sym!=NULL && op==TR::InstOpCode::label)
sym->setInstruction(this);
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sym : label symbol
* @param[in] cond : register dependency condition
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64LabelInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::LabelSymbol *sym,
TR::RegisterDependencyConditions *cond,
TR::Instruction *precedingInstruction, TR::CodeGenerator *cg)
: TR::Instruction(op, node, cond, precedingInstruction, cg), _symbol(sym)
{
if (sym!=NULL && op==TR::InstOpCode::label)
sym->setInstruction(this);
}
/**
* @brief Gets instruction kind
* @return instruction kind
*/
virtual Kind getKind() { return IsLabel; }
/**
* @brief Gets label symbol
* @return label symbol
*/
TR::LabelSymbol *getLabelSymbol() {return _symbol;}
/**
* @brief Sets label symbol
* @param[in] sym : label symbol
* @return label symbol
*/
TR::LabelSymbol *setLabelSymbol(TR::LabelSymbol *sym)
{
return (_symbol = sym);
}
virtual TR::Snippet *getSnippetForGC() {return getLabelSymbol()->getSnippet();}
/**
* @brief Sets immediate field in binary encoding
* @param[in] instruction : instruction cursor
* @param[in] distance : branch distance
*/
void insertImmediateField(uint32_t *instruction, int32_t distance)
{
TR_ASSERT((distance & 0x3) == 0, "branch distance is not aligned");
*instruction |= ((distance >> 2) & 0x3ffffff); // imm26
}
/**
* @brief Assigns registers
* @param[in] kindToBeAssigned : register kind
*/
virtual void assignRegisters(TR_RegisterKinds kindToBeAssigned);
/**
* @brief Generates binary encoding of the instruction
* @return instruction cursor
*/
virtual uint8_t *generateBinaryEncoding();
/**
* @brief Estimates binary length
* @param[in] currentEstimate : current estimated length
* @return estimated binary length
*/
virtual int32_t estimateBinaryLength(int32_t currentEstimate);
protected:
/**
* @brief Assigns registers for OutOfLineCodeSection
*
* @param[in] kindToBeAssigned : register kind
*/
void assignRegistersForOutOfLineCodeSection(TR_RegisterKinds kindToBeAssigned);
};
class ARM64ConditionalBranchInstruction : public ARM64LabelInstruction
{
int32_t _estimatedBinaryLocation;
TR::ARM64ConditionCode _cc;
public:
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sym : label symbol
* @param[in] cc : branch condition code
* @param[in] cg : CodeGenerator
*/
ARM64ConditionalBranchInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::LabelSymbol *sym,
TR::ARM64ConditionCode cc,
TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, cg), _cc(cc),
_estimatedBinaryLocation(0)
{
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sym : label symbol
* @param[in] cc : branch condition code
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64ConditionalBranchInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::LabelSymbol *sym,
TR::ARM64ConditionCode cc,
TR::Instruction *precedingInstruction, TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, precedingInstruction, cg), _cc(cc),
_estimatedBinaryLocation(0)
{
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sym : label symbol
* @param[in] cc : branch condition code
* @param[in] cond : register dependency condition
* @param[in] cg : CodeGenerator
*/
ARM64ConditionalBranchInstruction(
TR::InstOpCode::Mnemonic op,
TR::Node *node,
TR::LabelSymbol *sym,
TR::ARM64ConditionCode cc,
TR::RegisterDependencyConditions *cond, TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, cond, cg), _cc(cc),
_estimatedBinaryLocation(0)
{
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sym : label symbol
* @param[in] cc : branch condition code
* @param[in] cond : register dependency condition
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64ConditionalBranchInstruction(
TR::InstOpCode::Mnemonic op,
TR::Node *node,
TR::LabelSymbol *sym,
TR::ARM64ConditionCode cc,
TR::RegisterDependencyConditions *cond,
TR::Instruction *precedingInstruction, TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, cond, precedingInstruction, cg), _cc(cc),
_estimatedBinaryLocation(0)
{
}
/**
* @brief Gets instruction kind
* @return instruction kind
*/
virtual Kind getKind() { return IsConditionalBranch; }
/**
* @brief Gets estimated binary location
* @return estimated binary location
*/
int32_t getEstimatedBinaryLocation() {return _estimatedBinaryLocation;}
/**
* @brief Sets estimated binary location
* @param[in] l : estimated binary location
* @return estimated binary location
*/
int32_t setEstimatedBinaryLocation(int32_t l) {return (_estimatedBinaryLocation = l);}
/**
* @brief Gets condition code
* @return condition code
*/
TR::ARM64ConditionCode getConditionCode() {return _cc;}
/**
* @brief Sets condition code
* @param[in] cc : condition code
* @return condition code
*/
TR::ARM64ConditionCode setConditionCode(TR::ARM64ConditionCode cc) {return (_cc = cc);}
/**
* @brief Sets immediate field in binary encoding
* @param[in] instruction : instruction cursor
* @param[in] distance : branch distance
*/
void insertImmediateField(uint32_t *instruction, int32_t distance)
{
TR_ASSERT((distance & 0x3) == 0, "branch distance is not aligned");
*instruction |= ((distance >> 2) & 0x7ffff) << 5; // imm19
}
/**
* @brief Sets condition code in binary encoding
* @param[in] instruction : instruction cursor
*/
void insertConditionCodeField(uint32_t *instruction)
{
*instruction |= (_cc & 0xf);
}
/**
* @brief Generates binary encoding of the instruction
* @return instruction cursor
*/
virtual uint8_t *generateBinaryEncoding();
/**
* @brief Estimates binary length
* @param[in] currentEstimate : current estimated length
* @return estimated binary length
*/
virtual int32_t estimateBinaryLength(int32_t currentEstimate);
};
class ARM64CompareBranchInstruction : public ARM64LabelInstruction
{
int32_t _estimatedBinaryLocation;
TR::Register *_source1Register;
public:
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sreg : source register
* @param[in] sym : label symbol
* @param[in] cg : CodeGenerator
*/
ARM64CompareBranchInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::Register *sreg, TR::LabelSymbol *sym,
TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, cg), _source1Register(sreg),
_estimatedBinaryLocation(0)
{
useRegister(sreg);
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sreg : source register
* @param[in] sym : label symbol
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64CompareBranchInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::Register *sreg, TR::LabelSymbol *sym,
TR::Instruction *precedingInstruction, TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, precedingInstruction, cg), _source1Register(sreg),
_estimatedBinaryLocation(0)
{
useRegister(sreg);
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sreg : source register
* @param[in] sym : label symbol
* @param[in] cond : register dependency condition
* @param[in] cg : CodeGenerator
*/
ARM64CompareBranchInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::Register *sreg, TR::LabelSymbol *sym,
TR::RegisterDependencyConditions *cond, TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, cond, cg), _source1Register(sreg),
_estimatedBinaryLocation(0)
{
useRegister(sreg);
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sreg : source register
* @param[in] sym : label symbol
* @param[in] cond : register dependency condition
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64CompareBranchInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::Register *sreg, TR::LabelSymbol *sym,
TR::RegisterDependencyConditions *cond, TR::Instruction *precedingInstruction,
TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, cond, precedingInstruction, cg), _source1Register(sreg),
_estimatedBinaryLocation(0)
{
useRegister(sreg);
}
/**
* @brief Gets instruction kind
* @return instruction kind
*/
virtual Kind getKind() { return IsCompareBranch; }
/**
* @brief Gets estimated binary location
* @return estimated binary location
*/
int32_t getEstimatedBinaryLocation() {return _estimatedBinaryLocation;}
/**
* @brief Sets estimated binary location
* @param[in] l : estimated binary location
* @return estimated binary location
*/
int32_t setEstimatedBinaryLocation(int32_t l) {return (_estimatedBinaryLocation = l);}
/**
* @brief Gets source register
* @return source register
*/
TR::Register *getSource1Register() {return _source1Register;}
/**
* @brief Sets source register
* @param[in] sr : source register
* @return source register
*/
TR::Register *setSource1Register(TR::Register *sr) {return (_source1Register = sr);}
/**
* @brief Sets immediate field in binary encoding
* @param[in] instruction : instruction cursor
* @param[in] distance : branch distance
*/
void insertImmediateField(uint32_t *instruction, int32_t distance)
{
TR_ASSERT((distance & 0x3) == 0, "branch distance is not aligned");
*instruction |= ((distance >> 2) & 0x7ffff) << 5;
}
/**
* @brief Sets source register in binary encoding
* @param[in] instruction : instruction cursor
*/
void insertSource1Register(uint32_t *instruction)
{
TR::RealRegister *source1 = toRealRegister(_source1Register);
source1->setRegisterFieldRD(instruction);
}
/**
* @brief Answers whether this instruction references the given virtual register
* @param[in] reg : virtual register
* @return true when the instruction references the virtual register
*/
virtual bool refsRegister(TR::Register *reg);
/**
* @brief Answers whether this instruction uses the given virtual register
* @param[in] reg : virtual register
* @return true when the instruction uses the virtual register
*/
virtual bool usesRegister(TR::Register *reg);
/**
* @brief Answers whether this instruction defines the given virtual register
* @param[in] reg : virtual register
* @return true when the instruction defines the virtual register
*/
virtual bool defsRegister(TR::Register *reg);
/**
* @brief Answers whether this instruction defines the given real register
* @param[in] reg : real register
* @return true when the instruction defines the real register
*/
virtual bool defsRealRegister(TR::Register *reg);
/**
* @brief Assigns registers
* @param[in] kindToBeAssigned : register kind
*/
virtual void assignRegisters(TR_RegisterKinds kindToBeAssigned);
/**
* @brief Generates binary encoding of the instruction
* @return instruction cursor
*/
virtual uint8_t *generateBinaryEncoding();
};
class ARM64TestBitBranchInstruction : public ARM64LabelInstruction
{
int32_t _estimatedBinaryLocation;
TR::Register *_source1Register;
uint32_t _bitpos;
public:
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sreg : source register
* @param[in] bitpos : bit position to test
* @param[in] sym : label symbol
* @param[in] cg : CodeGenerator
*/
ARM64TestBitBranchInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::Register *sreg, uint32_t bitpos, TR::LabelSymbol *sym,
TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, cg), _source1Register(sreg),
_estimatedBinaryLocation(0), _bitpos(bitpos)
{
useRegister(sreg);
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sreg : source register
* @param[in] bitpos : bit position to test
* @param[in] sym : label symbol
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64TestBitBranchInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::Register *sreg, uint32_t bitpos, TR::LabelSymbol *sym,
TR::Instruction *precedingInstruction, TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, precedingInstruction, cg), _source1Register(sreg),
_estimatedBinaryLocation(0), _bitpos(bitpos)
{
useRegister(sreg);
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sreg : source register
* @param[in] bitpos : bit position to test
* @param[in] sym : label symbol
* @param[in] cond : register dependency condition
* @param[in] cg : CodeGenerator
*/
ARM64TestBitBranchInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::Register *sreg, uint32_t bitpos, TR::LabelSymbol *sym,
TR::RegisterDependencyConditions *cond, TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, cond, cg), _source1Register(sreg),
_estimatedBinaryLocation(0), _bitpos(bitpos)
{
useRegister(sreg);
}
/*
* @brief Constructor
* @param[in] op : instruction opcode
* @param[in] node : node
* @param[in] sreg : source register
* @param[in] bitpos : bit position to test
* @param[in] sym : label symbol
* @param[in] cond s : register dependency condition
* @param[in] precedingInstruction : preceding instruction
* @param[in] cg : CodeGenerator
*/
ARM64TestBitBranchInstruction(TR::InstOpCode::Mnemonic op, TR::Node *node, TR::Register *sreg, uint32_t bitpos, TR::LabelSymbol *sym,
TR::RegisterDependencyConditions *cond, TR::Instruction *precedingInstruction, TR::CodeGenerator *cg)
: ARM64LabelInstruction(op, node, sym, cond, precedingInstruction, cg), _source1Register(sreg),
_estimatedBinaryLocation(0), _bitpos(bitpos)
{
useRegister(sreg);
}
/**
* @brief Gets instruction kind
* @return instruction kind
*/
virtual Kind getKind() { return IsTestBitBranch; }
/**
* @brief Gets bit position
* @return bit position
*/
uint32_t getBitPos() { return _bitpos; }
/**
* @brief Sets bit position
* @param[in] bitpos : bit position
* @return bit position
*/
uint32_t setBitPos(uint32_t bitpos) { return (_bitpos = bitpos);}
/**
* @brief Gets estimated binary location
* @return estimated binary location
*/
int32_t getEstimatedBinaryLocation() {return _estimatedBinaryLocation;}
/**
* @brief Sets estimated binary location
* @param[in] l : estimated binary location
* @return estimated binary location
*/
int32_t setEstimatedBinaryLocation(int32_t l) {return (_estimatedBinaryLocation = l);}
/**
* @brief Gets source register
* @return source register
*/
TR::Register *getSource1Register() {return _source1Register;}
/**
* @brief Sets source register
* @param[in] sr : source register
* @return source register
*/
TR::Register *setSource1Register(TR::Register *sr) {return (_source1Register = sr);}
/**
* @brief Sets immediate field in binary encoding
* @param[in] instruction : instruction cursor
* @param[in] distance : branch distance
*/
void insertImmediateField(uint32_t *instruction, int32_t distance)
{
TR_ASSERT_FATAL((distance & 0x3) == 0, "branch distance is not aligned");
*instruction |= ((distance >> 2) & 0x3fff) << 5;
}
/**
* @brief Sets source register in binary encoding
* @param[in] instruction : instruction cursor
*/