1 //===- SIInstrInfo.h - SI Instruction Info Interface ------------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
10 /// Interface definition for SIInstrInfo.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_TARGET_AMDGPU_SIINSTRINFO_H
15 #define LLVM_LIB_TARGET_AMDGPU_SIINSTRINFO_H
17 #include "AMDGPUInstrInfo.h"
18 #include "SIDefines.h"
19 #include "SIRegisterInfo.h"
20 #include "Utils/AMDGPUBaseInfo.h"
21 #include "llvm/ADT/ArrayRef.h"
22 #include "llvm/ADT/SetVector.h"
23 #include "llvm/CodeGen/MachineBasicBlock.h"
24 #include "llvm/CodeGen/MachineFunction.h"
25 #include "llvm/CodeGen/MachineInstr.h"
26 #include "llvm/CodeGen/MachineInstrBuilder.h"
27 #include "llvm/CodeGen/MachineOperand.h"
28 #include "llvm/MC/MCInstrDesc.h"
29 #include "llvm/Support/Compiler.h"
33 #define GET_INSTRINFO_HEADER
34 #include "AMDGPUGenInstrInfo.inc"
39 class MachineDominatorTree
;
40 class MachineRegisterInfo
;
43 class TargetRegisterClass
;
45 class SIInstrInfo final
: public AMDGPUGenInstrInfo
{
47 const SIRegisterInfo RI
;
48 const GCNSubtarget
&ST
;
50 // The inverse predicate should have the negative value.
51 enum BranchPredicate
{
61 using SetVectorType
= SmallSetVector
<MachineInstr
*, 32>;
63 static unsigned getBranchOpcode(BranchPredicate Cond
);
64 static BranchPredicate
getBranchPredicate(unsigned Opcode
);
67 unsigned buildExtractSubReg(MachineBasicBlock::iterator MI
,
68 MachineRegisterInfo
&MRI
,
69 MachineOperand
&SuperReg
,
70 const TargetRegisterClass
*SuperRC
,
72 const TargetRegisterClass
*SubRC
) const;
73 MachineOperand
buildExtractSubRegOrImm(MachineBasicBlock::iterator MI
,
74 MachineRegisterInfo
&MRI
,
75 MachineOperand
&SuperReg
,
76 const TargetRegisterClass
*SuperRC
,
78 const TargetRegisterClass
*SubRC
) const;
80 void swapOperands(MachineInstr
&Inst
) const;
82 bool moveScalarAddSub(SetVectorType
&Worklist
, MachineInstr
&Inst
,
83 MachineDominatorTree
*MDT
= nullptr) const;
85 void lowerScalarAbs(SetVectorType
&Worklist
,
86 MachineInstr
&Inst
) const;
88 void lowerScalarXnor(SetVectorType
&Worklist
,
89 MachineInstr
&Inst
) const;
91 void splitScalarNotBinop(SetVectorType
&Worklist
,
93 unsigned Opcode
) const;
95 void splitScalarBinOpN2(SetVectorType
&Worklist
,
97 unsigned Opcode
) const;
99 void splitScalar64BitUnaryOp(SetVectorType
&Worklist
,
100 MachineInstr
&Inst
, unsigned Opcode
) const;
102 void splitScalar64BitAddSub(SetVectorType
&Worklist
, MachineInstr
&Inst
,
103 MachineDominatorTree
*MDT
= nullptr) const;
105 void splitScalar64BitBinaryOp(SetVectorType
&Worklist
, MachineInstr
&Inst
,
107 MachineDominatorTree
*MDT
= nullptr) const;
109 void splitScalar64BitXnor(SetVectorType
&Worklist
, MachineInstr
&Inst
,
110 MachineDominatorTree
*MDT
= nullptr) const;
112 void splitScalar64BitBCNT(SetVectorType
&Worklist
,
113 MachineInstr
&Inst
) const;
114 void splitScalar64BitBFE(SetVectorType
&Worklist
,
115 MachineInstr
&Inst
) const;
116 void movePackToVALU(SetVectorType
&Worklist
,
117 MachineRegisterInfo
&MRI
,
118 MachineInstr
&Inst
) const;
120 void addUsersToMoveToVALUWorklist(unsigned Reg
, MachineRegisterInfo
&MRI
,
121 SetVectorType
&Worklist
) const;
123 void addSCCDefUsersToVALUWorklist(MachineOperand
&Op
,
124 MachineInstr
&SCCDefInst
,
125 SetVectorType
&Worklist
) const;
127 const TargetRegisterClass
*
128 getDestEquivalentVGPRClass(const MachineInstr
&Inst
) const;
130 bool checkInstOffsetsDoNotOverlap(const MachineInstr
&MIa
,
131 const MachineInstr
&MIb
) const;
133 unsigned findUsedSGPR(const MachineInstr
&MI
, int OpIndices
[3]) const;
136 bool swapSourceModifiers(MachineInstr
&MI
,
137 MachineOperand
&Src0
, unsigned Src0OpName
,
138 MachineOperand
&Src1
, unsigned Src1OpName
) const;
140 MachineInstr
*commuteInstructionImpl(MachineInstr
&MI
, bool NewMI
,
142 unsigned OpIdx1
) const override
;
145 enum TargetOperandFlags
{
149 // MO_GOTPCREL -> symbol@GOTPCREL -> R_AMDGPU_GOTPCREL.
151 // MO_GOTPCREL32_LO -> symbol@gotpcrel32@lo -> R_AMDGPU_GOTPCREL32_LO.
153 MO_GOTPCREL32_LO
= 2,
154 // MO_GOTPCREL32_HI -> symbol@gotpcrel32@hi -> R_AMDGPU_GOTPCREL32_HI.
155 MO_GOTPCREL32_HI
= 3,
156 // MO_REL32_LO -> symbol@rel32@lo -> R_AMDGPU_REL32_LO.
159 // MO_REL32_HI -> symbol@rel32@hi -> R_AMDGPU_REL32_HI.
162 MO_LONG_BRANCH_FORWARD
= 6,
163 MO_LONG_BRANCH_BACKWARD
= 7,
169 explicit SIInstrInfo(const GCNSubtarget
&ST
);
171 const SIRegisterInfo
&getRegisterInfo() const {
175 bool isReallyTriviallyReMaterializable(const MachineInstr
&MI
,
176 AliasAnalysis
*AA
) const override
;
178 bool areLoadsFromSameBasePtr(SDNode
*Load1
, SDNode
*Load2
,
180 int64_t &Offset2
) const override
;
182 bool getMemOperandWithOffset(const MachineInstr
&LdSt
,
183 const MachineOperand
*&BaseOp
,
185 const TargetRegisterInfo
*TRI
) const final
;
187 bool shouldClusterMemOps(const MachineOperand
&BaseOp1
,
188 const MachineOperand
&BaseOp2
,
189 unsigned NumLoads
) const override
;
191 bool shouldScheduleLoadsNear(SDNode
*Load0
, SDNode
*Load1
, int64_t Offset0
,
192 int64_t Offset1
, unsigned NumLoads
) const override
;
194 void copyPhysReg(MachineBasicBlock
&MBB
, MachineBasicBlock::iterator MI
,
195 const DebugLoc
&DL
, unsigned DestReg
, unsigned SrcReg
,
196 bool KillSrc
) const override
;
198 unsigned calculateLDSSpillAddress(MachineBasicBlock
&MBB
, MachineInstr
&MI
,
199 RegScavenger
*RS
, unsigned TmpReg
,
200 unsigned Offset
, unsigned Size
) const;
202 void materializeImmediate(MachineBasicBlock
&MBB
,
203 MachineBasicBlock::iterator MI
,
206 int64_t Value
) const;
208 const TargetRegisterClass
*getPreferredSelectRegClass(
209 unsigned Size
) const;
211 unsigned insertNE(MachineBasicBlock
*MBB
,
212 MachineBasicBlock::iterator I
, const DebugLoc
&DL
,
213 unsigned SrcReg
, int Value
) const;
215 unsigned insertEQ(MachineBasicBlock
*MBB
,
216 MachineBasicBlock::iterator I
, const DebugLoc
&DL
,
217 unsigned SrcReg
, int Value
) const;
219 void storeRegToStackSlot(MachineBasicBlock
&MBB
,
220 MachineBasicBlock::iterator MI
, unsigned SrcReg
,
221 bool isKill
, int FrameIndex
,
222 const TargetRegisterClass
*RC
,
223 const TargetRegisterInfo
*TRI
) const override
;
225 void loadRegFromStackSlot(MachineBasicBlock
&MBB
,
226 MachineBasicBlock::iterator MI
, unsigned DestReg
,
227 int FrameIndex
, const TargetRegisterClass
*RC
,
228 const TargetRegisterInfo
*TRI
) const override
;
230 bool expandPostRAPseudo(MachineInstr
&MI
) const override
;
232 // Returns an opcode that can be used to move a value to a \p DstRC
233 // register. If there is no hardware instruction that can store to \p
234 // DstRC, then AMDGPU::COPY is returned.
235 unsigned getMovOpcode(const TargetRegisterClass
*DstRC
) const;
238 int commuteOpcode(unsigned Opc
) const;
241 inline int commuteOpcode(const MachineInstr
&MI
) const {
242 return commuteOpcode(MI
.getOpcode());
245 bool findCommutedOpIndices(MachineInstr
&MI
, unsigned &SrcOpIdx1
,
246 unsigned &SrcOpIdx2
) const override
;
248 bool findCommutedOpIndices(MCInstrDesc Desc
, unsigned & SrcOpIdx0
,
249 unsigned & SrcOpIdx1
) const;
251 bool isBranchOffsetInRange(unsigned BranchOpc
,
252 int64_t BrOffset
) const override
;
254 MachineBasicBlock
*getBranchDestBlock(const MachineInstr
&MI
) const override
;
256 unsigned insertIndirectBranch(MachineBasicBlock
&MBB
,
257 MachineBasicBlock
&NewDestBB
,
260 RegScavenger
*RS
= nullptr) const override
;
262 bool analyzeBranchImpl(MachineBasicBlock
&MBB
,
263 MachineBasicBlock::iterator I
,
264 MachineBasicBlock
*&TBB
,
265 MachineBasicBlock
*&FBB
,
266 SmallVectorImpl
<MachineOperand
> &Cond
,
267 bool AllowModify
) const;
269 bool analyzeBranch(MachineBasicBlock
&MBB
, MachineBasicBlock
*&TBB
,
270 MachineBasicBlock
*&FBB
,
271 SmallVectorImpl
<MachineOperand
> &Cond
,
272 bool AllowModify
= false) const override
;
274 unsigned removeBranch(MachineBasicBlock
&MBB
,
275 int *BytesRemoved
= nullptr) const override
;
277 unsigned insertBranch(MachineBasicBlock
&MBB
, MachineBasicBlock
*TBB
,
278 MachineBasicBlock
*FBB
, ArrayRef
<MachineOperand
> Cond
,
280 int *BytesAdded
= nullptr) const override
;
282 bool reverseBranchCondition(
283 SmallVectorImpl
<MachineOperand
> &Cond
) const override
;
285 bool canInsertSelect(const MachineBasicBlock
&MBB
,
286 ArrayRef
<MachineOperand
> Cond
,
287 unsigned TrueReg
, unsigned FalseReg
,
289 int &TrueCycles
, int &FalseCycles
) const override
;
291 void insertSelect(MachineBasicBlock
&MBB
,
292 MachineBasicBlock::iterator I
, const DebugLoc
&DL
,
293 unsigned DstReg
, ArrayRef
<MachineOperand
> Cond
,
294 unsigned TrueReg
, unsigned FalseReg
) const override
;
296 void insertVectorSelect(MachineBasicBlock
&MBB
,
297 MachineBasicBlock::iterator I
, const DebugLoc
&DL
,
298 unsigned DstReg
, ArrayRef
<MachineOperand
> Cond
,
299 unsigned TrueReg
, unsigned FalseReg
) const;
301 unsigned getAddressSpaceForPseudoSourceKind(
302 unsigned Kind
) const override
;
305 areMemAccessesTriviallyDisjoint(const MachineInstr
&MIa
,
306 const MachineInstr
&MIb
,
307 AliasAnalysis
*AA
= nullptr) const override
;
309 bool isFoldableCopy(const MachineInstr
&MI
) const;
311 bool FoldImmediate(MachineInstr
&UseMI
, MachineInstr
&DefMI
, unsigned Reg
,
312 MachineRegisterInfo
*MRI
) const final
;
314 unsigned getMachineCSELookAheadLimit() const override
{ return 500; }
316 MachineInstr
*convertToThreeAddress(MachineFunction::iterator
&MBB
,
318 LiveVariables
*LV
) const override
;
320 bool isSchedulingBoundary(const MachineInstr
&MI
,
321 const MachineBasicBlock
*MBB
,
322 const MachineFunction
&MF
) const override
;
324 static bool isSALU(const MachineInstr
&MI
) {
325 return MI
.getDesc().TSFlags
& SIInstrFlags::SALU
;
328 bool isSALU(uint16_t Opcode
) const {
329 return get(Opcode
).TSFlags
& SIInstrFlags::SALU
;
332 static bool isVALU(const MachineInstr
&MI
) {
333 return MI
.getDesc().TSFlags
& SIInstrFlags::VALU
;
336 bool isVALU(uint16_t Opcode
) const {
337 return get(Opcode
).TSFlags
& SIInstrFlags::VALU
;
340 static bool isVMEM(const MachineInstr
&MI
) {
341 return isMUBUF(MI
) || isMTBUF(MI
) || isMIMG(MI
);
344 bool isVMEM(uint16_t Opcode
) const {
345 return isMUBUF(Opcode
) || isMTBUF(Opcode
) || isMIMG(Opcode
);
348 static bool isSOP1(const MachineInstr
&MI
) {
349 return MI
.getDesc().TSFlags
& SIInstrFlags::SOP1
;
352 bool isSOP1(uint16_t Opcode
) const {
353 return get(Opcode
).TSFlags
& SIInstrFlags::SOP1
;
356 static bool isSOP2(const MachineInstr
&MI
) {
357 return MI
.getDesc().TSFlags
& SIInstrFlags::SOP2
;
360 bool isSOP2(uint16_t Opcode
) const {
361 return get(Opcode
).TSFlags
& SIInstrFlags::SOP2
;
364 static bool isSOPC(const MachineInstr
&MI
) {
365 return MI
.getDesc().TSFlags
& SIInstrFlags::SOPC
;
368 bool isSOPC(uint16_t Opcode
) const {
369 return get(Opcode
).TSFlags
& SIInstrFlags::SOPC
;
372 static bool isSOPK(const MachineInstr
&MI
) {
373 return MI
.getDesc().TSFlags
& SIInstrFlags::SOPK
;
376 bool isSOPK(uint16_t Opcode
) const {
377 return get(Opcode
).TSFlags
& SIInstrFlags::SOPK
;
380 static bool isSOPP(const MachineInstr
&MI
) {
381 return MI
.getDesc().TSFlags
& SIInstrFlags::SOPP
;
384 bool isSOPP(uint16_t Opcode
) const {
385 return get(Opcode
).TSFlags
& SIInstrFlags::SOPP
;
388 static bool isPacked(const MachineInstr
&MI
) {
389 return MI
.getDesc().TSFlags
& SIInstrFlags::IsPacked
;
392 bool isPacked(uint16_t Opcode
) const {
393 return get(Opcode
).TSFlags
& SIInstrFlags::IsPacked
;
396 static bool isVOP1(const MachineInstr
&MI
) {
397 return MI
.getDesc().TSFlags
& SIInstrFlags::VOP1
;
400 bool isVOP1(uint16_t Opcode
) const {
401 return get(Opcode
).TSFlags
& SIInstrFlags::VOP1
;
404 static bool isVOP2(const MachineInstr
&MI
) {
405 return MI
.getDesc().TSFlags
& SIInstrFlags::VOP2
;
408 bool isVOP2(uint16_t Opcode
) const {
409 return get(Opcode
).TSFlags
& SIInstrFlags::VOP2
;
412 static bool isVOP3(const MachineInstr
&MI
) {
413 return MI
.getDesc().TSFlags
& SIInstrFlags::VOP3
;
416 bool isVOP3(uint16_t Opcode
) const {
417 return get(Opcode
).TSFlags
& SIInstrFlags::VOP3
;
420 static bool isSDWA(const MachineInstr
&MI
) {
421 return MI
.getDesc().TSFlags
& SIInstrFlags::SDWA
;
424 bool isSDWA(uint16_t Opcode
) const {
425 return get(Opcode
).TSFlags
& SIInstrFlags::SDWA
;
428 static bool isVOPC(const MachineInstr
&MI
) {
429 return MI
.getDesc().TSFlags
& SIInstrFlags::VOPC
;
432 bool isVOPC(uint16_t Opcode
) const {
433 return get(Opcode
).TSFlags
& SIInstrFlags::VOPC
;
436 static bool isMUBUF(const MachineInstr
&MI
) {
437 return MI
.getDesc().TSFlags
& SIInstrFlags::MUBUF
;
440 bool isMUBUF(uint16_t Opcode
) const {
441 return get(Opcode
).TSFlags
& SIInstrFlags::MUBUF
;
444 static bool isMTBUF(const MachineInstr
&MI
) {
445 return MI
.getDesc().TSFlags
& SIInstrFlags::MTBUF
;
448 bool isMTBUF(uint16_t Opcode
) const {
449 return get(Opcode
).TSFlags
& SIInstrFlags::MTBUF
;
452 static bool isSMRD(const MachineInstr
&MI
) {
453 return MI
.getDesc().TSFlags
& SIInstrFlags::SMRD
;
456 bool isSMRD(uint16_t Opcode
) const {
457 return get(Opcode
).TSFlags
& SIInstrFlags::SMRD
;
460 bool isBufferSMRD(const MachineInstr
&MI
) const;
462 static bool isDS(const MachineInstr
&MI
) {
463 return MI
.getDesc().TSFlags
& SIInstrFlags::DS
;
466 bool isDS(uint16_t Opcode
) const {
467 return get(Opcode
).TSFlags
& SIInstrFlags::DS
;
470 bool isAlwaysGDS(uint16_t Opcode
) const;
472 static bool isMIMG(const MachineInstr
&MI
) {
473 return MI
.getDesc().TSFlags
& SIInstrFlags::MIMG
;
476 bool isMIMG(uint16_t Opcode
) const {
477 return get(Opcode
).TSFlags
& SIInstrFlags::MIMG
;
480 static bool isGather4(const MachineInstr
&MI
) {
481 return MI
.getDesc().TSFlags
& SIInstrFlags::Gather4
;
484 bool isGather4(uint16_t Opcode
) const {
485 return get(Opcode
).TSFlags
& SIInstrFlags::Gather4
;
488 static bool isFLAT(const MachineInstr
&MI
) {
489 return MI
.getDesc().TSFlags
& SIInstrFlags::FLAT
;
492 // Is a FLAT encoded instruction which accesses a specific segment,
493 // i.e. global_* or scratch_*.
494 static bool isSegmentSpecificFLAT(const MachineInstr
&MI
) {
495 auto Flags
= MI
.getDesc().TSFlags
;
496 return (Flags
& SIInstrFlags::FLAT
) && !(Flags
& SIInstrFlags::LGKM_CNT
);
499 // FIXME: Make this more precise
500 static bool isFLATScratch(const MachineInstr
&MI
) {
501 return isSegmentSpecificFLAT(MI
);
504 // Any FLAT encoded instruction, including global_* and scratch_*.
505 bool isFLAT(uint16_t Opcode
) const {
506 return get(Opcode
).TSFlags
& SIInstrFlags::FLAT
;
509 static bool isEXP(const MachineInstr
&MI
) {
510 return MI
.getDesc().TSFlags
& SIInstrFlags::EXP
;
513 bool isEXP(uint16_t Opcode
) const {
514 return get(Opcode
).TSFlags
& SIInstrFlags::EXP
;
517 static bool isWQM(const MachineInstr
&MI
) {
518 return MI
.getDesc().TSFlags
& SIInstrFlags::WQM
;
521 bool isWQM(uint16_t Opcode
) const {
522 return get(Opcode
).TSFlags
& SIInstrFlags::WQM
;
525 static bool isDisableWQM(const MachineInstr
&MI
) {
526 return MI
.getDesc().TSFlags
& SIInstrFlags::DisableWQM
;
529 bool isDisableWQM(uint16_t Opcode
) const {
530 return get(Opcode
).TSFlags
& SIInstrFlags::DisableWQM
;
533 static bool isVGPRSpill(const MachineInstr
&MI
) {
534 return MI
.getDesc().TSFlags
& SIInstrFlags::VGPRSpill
;
537 bool isVGPRSpill(uint16_t Opcode
) const {
538 return get(Opcode
).TSFlags
& SIInstrFlags::VGPRSpill
;
541 static bool isSGPRSpill(const MachineInstr
&MI
) {
542 return MI
.getDesc().TSFlags
& SIInstrFlags::SGPRSpill
;
545 bool isSGPRSpill(uint16_t Opcode
) const {
546 return get(Opcode
).TSFlags
& SIInstrFlags::SGPRSpill
;
549 static bool isDPP(const MachineInstr
&MI
) {
550 return MI
.getDesc().TSFlags
& SIInstrFlags::DPP
;
553 bool isDPP(uint16_t Opcode
) const {
554 return get(Opcode
).TSFlags
& SIInstrFlags::DPP
;
557 static bool isVOP3P(const MachineInstr
&MI
) {
558 return MI
.getDesc().TSFlags
& SIInstrFlags::VOP3P
;
561 bool isVOP3P(uint16_t Opcode
) const {
562 return get(Opcode
).TSFlags
& SIInstrFlags::VOP3P
;
565 static bool isVINTRP(const MachineInstr
&MI
) {
566 return MI
.getDesc().TSFlags
& SIInstrFlags::VINTRP
;
569 bool isVINTRP(uint16_t Opcode
) const {
570 return get(Opcode
).TSFlags
& SIInstrFlags::VINTRP
;
573 static bool isMAI(const MachineInstr
&MI
) {
574 return MI
.getDesc().TSFlags
& SIInstrFlags::IsMAI
;
577 bool isMAI(uint16_t Opcode
) const {
578 return get(Opcode
).TSFlags
& SIInstrFlags::IsMAI
;
581 static bool isScalarUnit(const MachineInstr
&MI
) {
582 return MI
.getDesc().TSFlags
& (SIInstrFlags::SALU
| SIInstrFlags::SMRD
);
585 static bool usesVM_CNT(const MachineInstr
&MI
) {
586 return MI
.getDesc().TSFlags
& SIInstrFlags::VM_CNT
;
589 static bool usesLGKM_CNT(const MachineInstr
&MI
) {
590 return MI
.getDesc().TSFlags
& SIInstrFlags::LGKM_CNT
;
593 static bool sopkIsZext(const MachineInstr
&MI
) {
594 return MI
.getDesc().TSFlags
& SIInstrFlags::SOPK_ZEXT
;
597 bool sopkIsZext(uint16_t Opcode
) const {
598 return get(Opcode
).TSFlags
& SIInstrFlags::SOPK_ZEXT
;
601 /// \returns true if this is an s_store_dword* instruction. This is more
602 /// specific than than isSMEM && mayStore.
603 static bool isScalarStore(const MachineInstr
&MI
) {
604 return MI
.getDesc().TSFlags
& SIInstrFlags::SCALAR_STORE
;
607 bool isScalarStore(uint16_t Opcode
) const {
608 return get(Opcode
).TSFlags
& SIInstrFlags::SCALAR_STORE
;
611 static bool isFixedSize(const MachineInstr
&MI
) {
612 return MI
.getDesc().TSFlags
& SIInstrFlags::FIXED_SIZE
;
615 bool isFixedSize(uint16_t Opcode
) const {
616 return get(Opcode
).TSFlags
& SIInstrFlags::FIXED_SIZE
;
619 static bool hasFPClamp(const MachineInstr
&MI
) {
620 return MI
.getDesc().TSFlags
& SIInstrFlags::FPClamp
;
623 bool hasFPClamp(uint16_t Opcode
) const {
624 return get(Opcode
).TSFlags
& SIInstrFlags::FPClamp
;
627 static bool hasIntClamp(const MachineInstr
&MI
) {
628 return MI
.getDesc().TSFlags
& SIInstrFlags::IntClamp
;
631 uint64_t getClampMask(const MachineInstr
&MI
) const {
632 const uint64_t ClampFlags
= SIInstrFlags::FPClamp
|
633 SIInstrFlags::IntClamp
|
634 SIInstrFlags::ClampLo
|
635 SIInstrFlags::ClampHi
;
636 return MI
.getDesc().TSFlags
& ClampFlags
;
639 static bool usesFPDPRounding(const MachineInstr
&MI
) {
640 return MI
.getDesc().TSFlags
& SIInstrFlags::FPDPRounding
;
643 bool usesFPDPRounding(uint16_t Opcode
) const {
644 return get(Opcode
).TSFlags
& SIInstrFlags::FPDPRounding
;
647 static bool isFPAtomic(const MachineInstr
&MI
) {
648 return MI
.getDesc().TSFlags
& SIInstrFlags::FPAtomic
;
651 bool isFPAtomic(uint16_t Opcode
) const {
652 return get(Opcode
).TSFlags
& SIInstrFlags::FPAtomic
;
655 bool isVGPRCopy(const MachineInstr
&MI
) const {
657 unsigned Dest
= MI
.getOperand(0).getReg();
658 const MachineFunction
&MF
= *MI
.getParent()->getParent();
659 const MachineRegisterInfo
&MRI
= MF
.getRegInfo();
660 return !RI
.isSGPRReg(MRI
, Dest
);
663 bool hasVGPRUses(const MachineInstr
&MI
) const {
664 const MachineFunction
&MF
= *MI
.getParent()->getParent();
665 const MachineRegisterInfo
&MRI
= MF
.getRegInfo();
666 return llvm::any_of(MI
.explicit_uses(),
667 [&MRI
, this](const MachineOperand
&MO
) {
668 return MO
.isReg() && RI
.isVGPR(MRI
, MO
.getReg());});
671 /// Whether we must prevent this instruction from executing with EXEC = 0.
672 bool hasUnwantedEffectsWhenEXECEmpty(const MachineInstr
&MI
) const;
674 /// Returns true if the instruction could potentially depend on the value of
675 /// exec. If false, exec dependencies may safely be ignored.
676 bool mayReadEXEC(const MachineRegisterInfo
&MRI
, const MachineInstr
&MI
) const;
678 bool isInlineConstant(const APInt
&Imm
) const;
680 bool isInlineConstant(const MachineOperand
&MO
, uint8_t OperandType
) const;
682 bool isInlineConstant(const MachineOperand
&MO
,
683 const MCOperandInfo
&OpInfo
) const {
684 return isInlineConstant(MO
, OpInfo
.OperandType
);
687 /// \p returns true if \p UseMO is substituted with \p DefMO in \p MI it would
688 /// be an inline immediate.
689 bool isInlineConstant(const MachineInstr
&MI
,
690 const MachineOperand
&UseMO
,
691 const MachineOperand
&DefMO
) const {
692 assert(UseMO
.getParent() == &MI
);
693 int OpIdx
= MI
.getOperandNo(&UseMO
);
694 if (!MI
.getDesc().OpInfo
|| OpIdx
>= MI
.getDesc().NumOperands
) {
698 return isInlineConstant(DefMO
, MI
.getDesc().OpInfo
[OpIdx
]);
701 /// \p returns true if the operand \p OpIdx in \p MI is a valid inline
703 bool isInlineConstant(const MachineInstr
&MI
, unsigned OpIdx
) const {
704 const MachineOperand
&MO
= MI
.getOperand(OpIdx
);
705 return isInlineConstant(MO
, MI
.getDesc().OpInfo
[OpIdx
].OperandType
);
708 bool isInlineConstant(const MachineInstr
&MI
, unsigned OpIdx
,
709 const MachineOperand
&MO
) const {
710 if (!MI
.getDesc().OpInfo
|| OpIdx
>= MI
.getDesc().NumOperands
)
714 unsigned Size
= getOpSize(MI
, OpIdx
);
715 assert(Size
== 8 || Size
== 4);
717 uint8_t OpType
= (Size
== 8) ?
718 AMDGPU::OPERAND_REG_IMM_INT64
: AMDGPU::OPERAND_REG_IMM_INT32
;
719 return isInlineConstant(MO
, OpType
);
722 return isInlineConstant(MO
, MI
.getDesc().OpInfo
[OpIdx
].OperandType
);
725 bool isInlineConstant(const MachineOperand
&MO
) const {
726 const MachineInstr
*Parent
= MO
.getParent();
727 return isInlineConstant(*Parent
, Parent
->getOperandNo(&MO
));
730 bool isLiteralConstant(const MachineOperand
&MO
,
731 const MCOperandInfo
&OpInfo
) const {
732 return MO
.isImm() && !isInlineConstant(MO
, OpInfo
.OperandType
);
735 bool isLiteralConstant(const MachineInstr
&MI
, int OpIdx
) const {
736 const MachineOperand
&MO
= MI
.getOperand(OpIdx
);
737 return MO
.isImm() && !isInlineConstant(MI
, OpIdx
);
740 // Returns true if this operand could potentially require a 32-bit literal
741 // operand, but not necessarily. A FrameIndex for example could resolve to an
742 // inline immediate value that will not require an additional 4-bytes; this
743 // assumes that it will.
744 bool isLiteralConstantLike(const MachineOperand
&MO
,
745 const MCOperandInfo
&OpInfo
) const;
747 bool isImmOperandLegal(const MachineInstr
&MI
, unsigned OpNo
,
748 const MachineOperand
&MO
) const;
750 /// Return true if this 64-bit VALU instruction has a 32-bit encoding.
751 /// This function will return false if you pass it a 32-bit instruction.
752 bool hasVALU32BitEncoding(unsigned Opcode
) const;
754 /// Returns true if this operand uses the constant bus.
755 bool usesConstantBus(const MachineRegisterInfo
&MRI
,
756 const MachineOperand
&MO
,
757 const MCOperandInfo
&OpInfo
) const;
759 /// Return true if this instruction has any modifiers.
760 /// e.g. src[012]_mod, omod, clamp.
761 bool hasModifiers(unsigned Opcode
) const;
763 bool hasModifiersSet(const MachineInstr
&MI
,
764 unsigned OpName
) const;
765 bool hasAnyModifiersSet(const MachineInstr
&MI
) const;
767 bool canShrink(const MachineInstr
&MI
,
768 const MachineRegisterInfo
&MRI
) const;
770 MachineInstr
*buildShrunkInst(MachineInstr
&MI
,
771 unsigned NewOpcode
) const;
773 bool verifyInstruction(const MachineInstr
&MI
,
774 StringRef
&ErrInfo
) const override
;
776 unsigned getVALUOp(const MachineInstr
&MI
) const;
778 /// Return the correct register class for \p OpNo. For target-specific
779 /// instructions, this will return the register class that has been defined
780 /// in tablegen. For generic instructions, like REG_SEQUENCE it will return
781 /// the register class of its machine operand.
782 /// to infer the correct register class base on the other operands.
783 const TargetRegisterClass
*getOpRegClass(const MachineInstr
&MI
,
784 unsigned OpNo
) const;
786 /// Return the size in bytes of the operand OpNo on the given
787 // instruction opcode.
788 unsigned getOpSize(uint16_t Opcode
, unsigned OpNo
) const {
789 const MCOperandInfo
&OpInfo
= get(Opcode
).OpInfo
[OpNo
];
791 if (OpInfo
.RegClass
== -1) {
792 // If this is an immediate operand, this must be a 32-bit literal.
793 assert(OpInfo
.OperandType
== MCOI::OPERAND_IMMEDIATE
);
797 return RI
.getRegSizeInBits(*RI
.getRegClass(OpInfo
.RegClass
)) / 8;
800 /// This form should usually be preferred since it handles operands
801 /// with unknown register classes.
802 unsigned getOpSize(const MachineInstr
&MI
, unsigned OpNo
) const {
803 const MachineOperand
&MO
= MI
.getOperand(OpNo
);
805 if (unsigned SubReg
= MO
.getSubReg()) {
806 assert(RI
.getRegSizeInBits(*RI
.getSubClassWithSubReg(
807 MI
.getParent()->getParent()->getRegInfo().
808 getRegClass(MO
.getReg()), SubReg
)) >= 32 &&
809 "Sub-dword subregs are not supported");
810 return RI
.getSubRegIndexLaneMask(SubReg
).getNumLanes() * 4;
813 return RI
.getRegSizeInBits(*getOpRegClass(MI
, OpNo
)) / 8;
816 /// Legalize the \p OpIndex operand of this instruction by inserting
817 /// a MOV. For example:
818 /// ADD_I32_e32 VGPR0, 15
821 /// ADD_I32_e32 VGPR0, VGPR1
823 /// If the operand being legalized is a register, then a COPY will be used
825 void legalizeOpWithMove(MachineInstr
&MI
, unsigned OpIdx
) const;
827 /// Check if \p MO is a legal operand if it was the \p OpIdx Operand
829 bool isOperandLegal(const MachineInstr
&MI
, unsigned OpIdx
,
830 const MachineOperand
*MO
= nullptr) const;
832 /// Check if \p MO would be a valid operand for the given operand
833 /// definition \p OpInfo. Note this does not attempt to validate constant bus
834 /// restrictions (e.g. literal constant usage).
835 bool isLegalVSrcOperand(const MachineRegisterInfo
&MRI
,
836 const MCOperandInfo
&OpInfo
,
837 const MachineOperand
&MO
) const;
839 /// Check if \p MO (a register operand) is a legal register for the
840 /// given operand description.
841 bool isLegalRegOperand(const MachineRegisterInfo
&MRI
,
842 const MCOperandInfo
&OpInfo
,
843 const MachineOperand
&MO
) const;
845 /// Legalize operands in \p MI by either commuting it or inserting a
847 void legalizeOperandsVOP2(MachineRegisterInfo
&MRI
, MachineInstr
&MI
) const;
849 /// Fix operands in \p MI to satisfy constant bus requirements.
850 void legalizeOperandsVOP3(MachineRegisterInfo
&MRI
, MachineInstr
&MI
) const;
852 /// Copy a value from a VGPR (\p SrcReg) to SGPR. This function can only
853 /// be used when it is know that the value in SrcReg is same across all
854 /// threads in the wave.
855 /// \returns The SGPR register that \p SrcReg was copied to.
856 unsigned readlaneVGPRToSGPR(unsigned SrcReg
, MachineInstr
&UseMI
,
857 MachineRegisterInfo
&MRI
) const;
859 void legalizeOperandsSMRD(MachineRegisterInfo
&MRI
, MachineInstr
&MI
) const;
861 void legalizeGenericOperand(MachineBasicBlock
&InsertMBB
,
862 MachineBasicBlock::iterator I
,
863 const TargetRegisterClass
*DstRC
,
864 MachineOperand
&Op
, MachineRegisterInfo
&MRI
,
865 const DebugLoc
&DL
) const;
867 /// Legalize all operands in this instruction. This function may create new
868 /// instructions and control-flow around \p MI. If present, \p MDT is
870 void legalizeOperands(MachineInstr
&MI
,
871 MachineDominatorTree
*MDT
= nullptr) const;
873 /// Replace this instruction's opcode with the equivalent VALU
874 /// opcode. This function will also move the users of \p MI to the
875 /// VALU if necessary. If present, \p MDT is updated.
876 void moveToVALU(MachineInstr
&MI
, MachineDominatorTree
*MDT
= nullptr) const;
878 void insertWaitStates(MachineBasicBlock
&MBB
,MachineBasicBlock::iterator MI
,
881 void insertNoop(MachineBasicBlock
&MBB
,
882 MachineBasicBlock::iterator MI
) const override
;
884 void insertReturn(MachineBasicBlock
&MBB
) const;
885 /// Return the number of wait states that result from executing this
887 static unsigned getNumWaitStates(const MachineInstr
&MI
);
889 /// Returns the operand named \p Op. If \p MI does not have an
890 /// operand named \c Op, this function returns nullptr.
892 MachineOperand
*getNamedOperand(MachineInstr
&MI
, unsigned OperandName
) const;
895 const MachineOperand
*getNamedOperand(const MachineInstr
&MI
,
896 unsigned OpName
) const {
897 return getNamedOperand(const_cast<MachineInstr
&>(MI
), OpName
);
900 /// Get required immediate operand
901 int64_t getNamedImmOperand(const MachineInstr
&MI
, unsigned OpName
) const {
902 int Idx
= AMDGPU::getNamedOperandIdx(MI
.getOpcode(), OpName
);
903 return MI
.getOperand(Idx
).getImm();
906 uint64_t getDefaultRsrcDataFormat() const;
907 uint64_t getScratchRsrcWords23() const;
909 bool isLowLatencyInstruction(const MachineInstr
&MI
) const;
910 bool isHighLatencyInstruction(const MachineInstr
&MI
) const;
912 /// Return the descriptor of the target-specific machine instruction
913 /// that corresponds to the specified pseudo or native opcode.
914 const MCInstrDesc
&getMCOpcodeFromPseudo(unsigned Opcode
) const {
915 return get(pseudoToMCOpcode(Opcode
));
918 unsigned isStackAccess(const MachineInstr
&MI
, int &FrameIndex
) const;
919 unsigned isSGPRStackAccess(const MachineInstr
&MI
, int &FrameIndex
) const;
921 unsigned isLoadFromStackSlot(const MachineInstr
&MI
,
922 int &FrameIndex
) const override
;
923 unsigned isStoreToStackSlot(const MachineInstr
&MI
,
924 int &FrameIndex
) const override
;
926 unsigned getInstBundleSize(const MachineInstr
&MI
) const;
927 unsigned getInstSizeInBytes(const MachineInstr
&MI
) const override
;
929 bool mayAccessFlatAddressSpace(const MachineInstr
&MI
) const;
931 bool isNonUniformBranchInstr(MachineInstr
&Instr
) const;
933 void convertNonUniformIfRegion(MachineBasicBlock
*IfEntry
,
934 MachineBasicBlock
*IfEnd
) const;
936 void convertNonUniformLoopRegion(MachineBasicBlock
*LoopEntry
,
937 MachineBasicBlock
*LoopEnd
) const;
939 std::pair
<unsigned, unsigned>
940 decomposeMachineOperandsTargetFlags(unsigned TF
) const override
;
942 ArrayRef
<std::pair
<int, const char *>>
943 getSerializableTargetIndices() const override
;
945 ArrayRef
<std::pair
<unsigned, const char *>>
946 getSerializableDirectMachineOperandTargetFlags() const override
;
948 ScheduleHazardRecognizer
*
949 CreateTargetPostRAHazardRecognizer(const InstrItineraryData
*II
,
950 const ScheduleDAG
*DAG
) const override
;
952 ScheduleHazardRecognizer
*
953 CreateTargetPostRAHazardRecognizer(const MachineFunction
&MF
) const override
;
955 bool isBasicBlockPrologue(const MachineInstr
&MI
) const override
;
957 /// Return a partially built integer add instruction without carry.
958 /// Caller must add source operands.
959 /// For pre-GFX9 it will generate unused carry destination operand.
960 /// TODO: After GFX9 it should return a no-carry operation.
961 MachineInstrBuilder
getAddNoCarry(MachineBasicBlock
&MBB
,
962 MachineBasicBlock::iterator I
,
964 unsigned DestReg
) const;
966 MachineInstrBuilder
getAddNoCarry(MachineBasicBlock
&MBB
,
967 MachineBasicBlock::iterator I
,
970 RegScavenger
&RS
) const;
972 static bool isKillTerminator(unsigned Opcode
);
973 const MCInstrDesc
&getKillTerminatorFromPseudo(unsigned Opcode
) const;
975 static bool isLegalMUBUFImmOffset(unsigned Imm
) {
976 return isUInt
<12>(Imm
);
979 /// Returns if \p Offset is legal for the subtarget as the offset to a FLAT
980 /// encoded instruction. If \p Signed, this is for an instruction that
981 /// interprets the offset as signed.
982 bool isLegalFLATOffset(int64_t Offset
, unsigned AddrSpace
,
985 /// \brief Return a target-specific opcode if Opcode is a pseudo instruction.
986 /// Return -1 if the target-specific opcode for the pseudo instruction does
987 /// not exist. If Opcode is not a pseudo instruction, this is identity.
988 int pseudoToMCOpcode(int Opcode
) const;
990 const TargetRegisterClass
*getRegClass(const MCInstrDesc
&TID
, unsigned OpNum
,
991 const TargetRegisterInfo
*TRI
,
992 const MachineFunction
&MF
)
994 if (OpNum
>= TID
.getNumOperands())
996 return RI
.getRegClass(TID
.OpInfo
[OpNum
].RegClass
);
999 void fixImplicitOperands(MachineInstr
&MI
) const;
1002 /// \brief Returns true if a reg:subreg pair P has a TRC class
1003 inline bool isOfRegClass(const TargetInstrInfo::RegSubRegPair
&P
,
1004 const TargetRegisterClass
&TRC
,
1005 MachineRegisterInfo
&MRI
) {
1006 auto *RC
= MRI
.getRegClass(P
.Reg
);
1009 auto *TRI
= MRI
.getTargetRegisterInfo();
1010 return RC
== TRI
->getMatchingSuperRegClass(RC
, &TRC
, P
.SubReg
);
1013 /// \brief Create RegSubRegPair from a register MachineOperand
1015 TargetInstrInfo::RegSubRegPair
getRegSubRegPair(const MachineOperand
&O
) {
1017 return TargetInstrInfo::RegSubRegPair(O
.getReg(), O
.getSubReg());
1020 /// \brief Return the SubReg component from REG_SEQUENCE
1021 TargetInstrInfo::RegSubRegPair
getRegSequenceSubReg(MachineInstr
&MI
,
1024 /// \brief Return the defining instruction for a given reg:subreg pair
1025 /// skipping copy like instructions and subreg-manipulation pseudos.
1026 /// Following another subreg of a reg:subreg isn't supported.
1027 MachineInstr
*getVRegSubRegDef(const TargetInstrInfo::RegSubRegPair
&P
,
1028 MachineRegisterInfo
&MRI
);
1030 /// \brief Return false if EXEC is not changed between the def of \p VReg at \p
1031 /// DefMI and the use at \p UseMI. Should be run on SSA. Currently does not
1032 /// attempt to track between blocks.
1033 bool execMayBeModifiedBeforeUse(const MachineRegisterInfo
&MRI
,
1035 const MachineInstr
&DefMI
,
1036 const MachineInstr
&UseMI
);
1038 /// \brief Return false if EXEC is not changed between the def of \p VReg at \p
1039 /// DefMI and all its uses. Should be run on SSA. Currently does not attempt to
1040 /// track between blocks.
1041 bool execMayBeModifiedBeforeAnyUse(const MachineRegisterInfo
&MRI
,
1043 const MachineInstr
&DefMI
);
1048 int getVOPe64(uint16_t Opcode
);
1051 int getVOPe32(uint16_t Opcode
);
1054 int getSDWAOp(uint16_t Opcode
);
1057 int getDPPOp32(uint16_t Opcode
);
1060 int getBasicFromSDWAOp(uint16_t Opcode
);
1063 int getCommuteRev(uint16_t Opcode
);
1066 int getCommuteOrig(uint16_t Opcode
);
1069 int getAddr64Inst(uint16_t Opcode
);
1071 /// Check if \p Opcode is an Addr64 opcode.
1073 /// \returns \p Opcode if it is an Addr64 opcode, otherwise -1.
1075 int getIfAddr64Inst(uint16_t Opcode
);
1078 int getMUBUFNoLdsInst(uint16_t Opcode
);
1081 int getAtomicRetOp(uint16_t Opcode
);
1084 int getAtomicNoRetOp(uint16_t Opcode
);
1087 int getSOPKOp(uint16_t Opcode
);
1090 int getGlobalSaddrOp(uint16_t Opcode
);
1093 int getVCMPXNoSDstOp(uint16_t Opcode
);
1095 const uint64_t RSRC_DATA_FORMAT
= 0xf00000000000LL
;
1096 const uint64_t RSRC_ELEMENT_SIZE_SHIFT
= (32 + 19);
1097 const uint64_t RSRC_INDEX_STRIDE_SHIFT
= (32 + 21);
1098 const uint64_t RSRC_TID_ENABLE
= UINT64_C(1) << (32 + 23);
1100 } // end namespace AMDGPU
1103 namespace KernelInputOffsets
{
1105 /// Offsets in bytes from the start of the input buffer
1118 } // end namespace KernelInputOffsets
1119 } // end namespace SI
1121 } // end namespace llvm
1123 #endif // LLVM_LIB_TARGET_AMDGPU_SIINSTRINFO_H