1 //===-- SIFixSGPRCopies.cpp - Remove potential VGPR => SGPR copies --------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// Copies from VGPR to SGPR registers are illegal and the register coalescer
12 /// will sometimes generate these illegal copies in situations like this:
14 /// Register Class <vsrc> is the union of <vgpr> and <sgpr>
17 /// %vreg0 <sgpr> = SCALAR_INST
18 /// %vreg1 <vsrc> = COPY %vreg0 <sgpr>
20 /// BRANCH %cond BB1, BB2
22 /// %vreg2 <vgpr> = VECTOR_INST
23 /// %vreg3 <vsrc> = COPY %vreg2 <vgpr>
25 /// %vreg4 <vsrc> = PHI %vreg1 <vsrc>, <BB#0>, %vreg3 <vrsc>, <BB#1>
26 /// %vreg5 <vgpr> = VECTOR_INST %vreg4 <vsrc>
29 /// The coalescer will begin at BB0 and eliminate its copy, then the resulting
30 /// code will look like this:
33 /// %vreg0 <sgpr> = SCALAR_INST
35 /// BRANCH %cond BB1, BB2
37 /// %vreg2 <vgpr> = VECTOR_INST
38 /// %vreg3 <vsrc> = COPY %vreg2 <vgpr>
40 /// %vreg4 <sgpr> = PHI %vreg0 <sgpr>, <BB#0>, %vreg3 <vsrc>, <BB#1>
41 /// %vreg5 <vgpr> = VECTOR_INST %vreg4 <sgpr>
43 /// Now that the result of the PHI instruction is an SGPR, the register
44 /// allocator is now forced to constrain the register class of %vreg3 to
45 /// <sgpr> so we end up with final code like this:
48 /// %vreg0 <sgpr> = SCALAR_INST
50 /// BRANCH %cond BB1, BB2
52 /// %vreg2 <vgpr> = VECTOR_INST
53 /// %vreg3 <sgpr> = COPY %vreg2 <vgpr>
55 /// %vreg4 <sgpr> = PHI %vreg0 <sgpr>, <BB#0>, %vreg3 <sgpr>, <BB#1>
56 /// %vreg5 <vgpr> = VECTOR_INST %vreg4 <sgpr>
58 /// Now this code contains an illegal copy from a VGPR to an SGPR.
60 /// In order to avoid this problem, this pass searches for PHI instructions
61 /// which define a <vsrc> register and constrains its definition class to
62 /// <vgpr> if the user of the PHI's definition register is a vector instruction.
63 /// If the PHI's definition class is constrained to <vgpr> then the coalescer
64 /// will be unable to perform the COPY removal from the above example which
65 /// ultimately led to the creation of an illegal COPY.
66 //===----------------------------------------------------------------------===//
69 #include "SIInstrInfo.h"
70 #include "llvm/CodeGen/MachineFunctionPass.h"
71 #include "llvm/CodeGen/MachineInstrBuilder.h"
72 #include "llvm/CodeGen/MachineRegisterInfo.h"
73 #include "llvm/Support/Debug.h"
74 #include "llvm/Support/raw_ostream.h"
75 #include "llvm/Target/TargetMachine.h"
79 #define DEBUG_TYPE "sgpr-copies"
83 class SIFixSGPRCopies : public MachineFunctionPass {
87 const TargetRegisterClass *inferRegClassFromUses(const SIRegisterInfo *TRI,
88 const MachineRegisterInfo &MRI,
90 unsigned SubReg) const;
91 const TargetRegisterClass *inferRegClassFromDef(const SIRegisterInfo *TRI,
92 const MachineRegisterInfo &MRI,
94 unsigned SubReg) const;
95 bool isVGPRToSGPRCopy(const MachineInstr &Copy, const SIRegisterInfo *TRI,
96 const MachineRegisterInfo &MRI) const;
99 SIFixSGPRCopies(TargetMachine &tm) : MachineFunctionPass(ID) { }
101 bool runOnMachineFunction(MachineFunction &MF) override;
103 const char *getPassName() const override {
104 return "SI Fix SGPR copies";
109 } // End anonymous namespace
111 char SIFixSGPRCopies::ID = 0;
113 FunctionPass *llvm::createSIFixSGPRCopiesPass(TargetMachine &tm) {
114 return new SIFixSGPRCopies(tm);
117 static bool hasVGPROperands(const MachineInstr &MI, const SIRegisterInfo *TRI) {
118 const MachineRegisterInfo &MRI = MI.getParent()->getParent()->getRegInfo();
119 for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
120 if (!MI.getOperand(i).isReg() ||
121 !TargetRegisterInfo::isVirtualRegister(MI.getOperand(i).getReg()))
124 if (TRI->hasVGPRs(MRI.getRegClass(MI.getOperand(i).getReg())))
130 /// This functions walks the use list of Reg until it finds an Instruction
131 /// that isn't a COPY returns the register class of that instruction.
132 /// \return The register defined by the first non-COPY instruction.
133 const TargetRegisterClass *SIFixSGPRCopies::inferRegClassFromUses(
134 const SIRegisterInfo *TRI,
135 const MachineRegisterInfo &MRI,
137 unsigned SubReg) const {
138 // The Reg parameter to the function must always be defined by either a PHI
139 // or a COPY, therefore it cannot be a physical register.
140 assert(TargetRegisterInfo::isVirtualRegister(Reg) &&
141 "Reg cannot be a physical register");
143 const TargetRegisterClass *RC = MRI.getRegClass(Reg);
144 RC = TRI->getSubRegClass(RC, SubReg);
145 for (MachineRegisterInfo::use_instr_iterator
146 I = MRI.use_instr_begin(Reg), E = MRI.use_instr_end(); I != E; ++I) {
147 switch (I->getOpcode()) {
149 RC = TRI->getCommonSubClass(RC, inferRegClassFromUses(TRI, MRI,
150 I->getOperand(0).getReg(),
151 I->getOperand(0).getSubReg()));
159 const TargetRegisterClass *SIFixSGPRCopies::inferRegClassFromDef(
160 const SIRegisterInfo *TRI,
161 const MachineRegisterInfo &MRI,
163 unsigned SubReg) const {
164 if (!TargetRegisterInfo::isVirtualRegister(Reg)) {
165 const TargetRegisterClass *RC = TRI->getPhysRegClass(Reg);
166 return TRI->getSubRegClass(RC, SubReg);
168 MachineInstr *Def = MRI.getVRegDef(Reg);
169 if (Def->getOpcode() != AMDGPU::COPY) {
170 return TRI->getSubRegClass(MRI.getRegClass(Reg), SubReg);
173 return inferRegClassFromDef(TRI, MRI, Def->getOperand(1).getReg(),
174 Def->getOperand(1).getSubReg());
177 bool SIFixSGPRCopies::isVGPRToSGPRCopy(const MachineInstr &Copy,
178 const SIRegisterInfo *TRI,
179 const MachineRegisterInfo &MRI) const {
181 unsigned DstReg = Copy.getOperand(0).getReg();
182 unsigned SrcReg = Copy.getOperand(1).getReg();
183 unsigned SrcSubReg = Copy.getOperand(1).getSubReg();
184 const TargetRegisterClass *DstRC = MRI.getRegClass(DstReg);
185 const TargetRegisterClass *SrcRC;
187 if (!TargetRegisterInfo::isVirtualRegister(SrcReg) ||
188 DstRC == &AMDGPU::M0RegRegClass ||
189 MRI.getRegClass(SrcReg) == &AMDGPU::VReg_1RegClass)
192 SrcRC = TRI->getSubRegClass(MRI.getRegClass(SrcReg), SrcSubReg);
193 return TRI->isSGPRClass(DstRC) && TRI->hasVGPRs(SrcRC);
196 bool SIFixSGPRCopies::runOnMachineFunction(MachineFunction &MF) {
197 MachineRegisterInfo &MRI = MF.getRegInfo();
198 const SIRegisterInfo *TRI = static_cast<const SIRegisterInfo *>(
199 MF.getTarget().getRegisterInfo());
200 const SIInstrInfo *TII = static_cast<const SIInstrInfo *>(
201 MF.getTarget().getInstrInfo());
202 for (MachineFunction::iterator BI = MF.begin(), BE = MF.end();
205 MachineBasicBlock &MBB = *BI;
206 for (MachineBasicBlock::iterator I = MBB.begin(), E = MBB.end();
208 MachineInstr &MI = *I;
209 if (MI.getOpcode() == AMDGPU::COPY && isVGPRToSGPRCopy(MI, TRI, MRI)) {
210 DEBUG(dbgs() << "Fixing VGPR -> SGPR copy:\n");
211 DEBUG(MI.print(dbgs()));
216 switch (MI.getOpcode()) {
219 DEBUG(dbgs() << " Fixing PHI:\n");
220 DEBUG(MI.print(dbgs()));
222 for (unsigned i = 1; i < MI.getNumOperands(); i+=2) {
223 unsigned Reg = MI.getOperand(i).getReg();
224 const TargetRegisterClass *RC = inferRegClassFromDef(TRI, MRI, Reg,
225 MI.getOperand(0).getSubReg());
226 MRI.constrainRegClass(Reg, RC);
228 unsigned Reg = MI.getOperand(0).getReg();
229 const TargetRegisterClass *RC = inferRegClassFromUses(TRI, MRI, Reg,
230 MI.getOperand(0).getSubReg());
231 if (TRI->getCommonSubClass(RC, &AMDGPU::VReg_32RegClass)) {
232 MRI.constrainRegClass(Reg, &AMDGPU::VReg_32RegClass);
235 if (!TRI->isSGPRClass(MRI.getRegClass(Reg)))
238 // If a PHI node defines an SGPR and any of its operands are VGPRs,
239 // then we need to move it to the VALU.
240 for (unsigned i = 1; i < MI.getNumOperands(); i+=2) {
241 unsigned Reg = MI.getOperand(i).getReg();
242 if (TRI->hasVGPRs(MRI.getRegClass(Reg))) {
250 case AMDGPU::REG_SEQUENCE: {
251 if (TRI->hasVGPRs(TII->getOpRegClass(MI, 0)) ||
252 !hasVGPROperands(MI, TRI))
255 DEBUG(dbgs() << "Fixing REG_SEQUENCE:\n");
256 DEBUG(MI.print(dbgs()));
261 case AMDGPU::INSERT_SUBREG: {
262 const TargetRegisterClass *DstRC, *SrcRC;
263 DstRC = MRI.getRegClass(MI.getOperand(0).getReg());
264 SrcRC = MRI.getRegClass(MI.getOperand(1).getReg());
265 if (!TRI->isSGPRClass(DstRC) || !TRI->hasVGPRs(SrcRC))
267 DEBUG(dbgs() << " Fixing INSERT_SUBREG:\n");
268 DEBUG(MI.print(dbgs()));