1 //===-- SILowerControlFlow.cpp - Use predicates for control flow ----------===//
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 /// \brief This pass lowers the pseudo control flow instructions to real
12 /// machine instructions.
14 /// All control flow is handled using predicated instructions and
15 /// a predicate stack. Each Scalar ALU controls the operations of 64 Vector
16 /// ALUs. The Scalar ALU can update the predicate for any of the Vector ALUs
17 /// by writting to the 64-bit EXEC register (each bit corresponds to a
18 /// single vector ALU). Typically, for predicates, a vector ALU will write
19 /// to its bit of the VCC register (like EXEC VCC is 64-bits, one for each
20 /// Vector ALU) and then the ScalarALU will AND the VCC register with the
21 /// EXEC to update the predicates.
24 /// %VCC = V_CMP_GT_F32 %VGPR1, %VGPR2
25 /// %SGPR0 = SI_IF %VCC
26 /// %VGPR0 = V_ADD_F32 %VGPR0, %VGPR0
27 /// %SGPR0 = SI_ELSE %SGPR0
28 /// %VGPR0 = V_SUB_F32 %VGPR0, %VGPR0
33 /// %SGPR0 = S_AND_SAVEEXEC_B64 %VCC // Save and update the exec mask
34 /// %SGPR0 = S_XOR_B64 %SGPR0, %EXEC // Clear live bits from saved exec mask
35 /// S_CBRANCH_EXECZ label0 // This instruction is an optional
36 /// // optimization which allows us to
37 /// // branch if all the bits of
39 /// %VGPR0 = V_ADD_F32 %VGPR0, %VGPR0 // Do the IF block of the branch
42 /// %SGPR0 = S_OR_SAVEEXEC_B64 %EXEC // Restore the exec mask for the Then block
43 /// %EXEC = S_XOR_B64 %SGPR0, %EXEC // Clear live bits from saved exec mask
44 /// S_BRANCH_EXECZ label1 // Use our branch optimization
45 /// // instruction again.
46 /// %VGPR0 = V_SUB_F32 %VGPR0, %VGPR // Do the THEN block
48 /// %EXEC = S_OR_B64 %EXEC, %SGPR0 // Re-enable saved exec mask bits
49 //===----------------------------------------------------------------------===//
52 #include "SIInstrInfo.h"
53 #include "SIMachineFunctionInfo.h"
54 #include "llvm/CodeGen/MachineFunction.h"
55 #include "llvm/CodeGen/MachineFunctionPass.h"
56 #include "llvm/CodeGen/MachineInstrBuilder.h"
57 #include "llvm/CodeGen/MachineRegisterInfo.h"
63 class SILowerControlFlowPass : public MachineFunctionPass {
66 static const unsigned SkipThreshold = 12;
69 const TargetRegisterInfo *TRI;
70 const TargetInstrInfo *TII;
72 bool shouldSkip(MachineBasicBlock *From, MachineBasicBlock *To);
74 void Skip(MachineInstr &From, MachineOperand &To);
75 void SkipIfDead(MachineInstr &MI);
77 void If(MachineInstr &MI);
78 void Else(MachineInstr &MI);
79 void Break(MachineInstr &MI);
80 void IfBreak(MachineInstr &MI);
81 void ElseBreak(MachineInstr &MI);
82 void Loop(MachineInstr &MI);
83 void EndCf(MachineInstr &MI);
85 void Kill(MachineInstr &MI);
86 void Branch(MachineInstr &MI);
88 void LoadM0(MachineInstr &MI, MachineInstr *MovRel);
89 void IndirectSrc(MachineInstr &MI);
90 void IndirectDst(MachineInstr &MI);
93 SILowerControlFlowPass(TargetMachine &tm) :
94 MachineFunctionPass(ID), TRI(tm.getRegisterInfo()),
95 TII(tm.getInstrInfo()) { }
97 virtual bool runOnMachineFunction(MachineFunction &MF);
99 const char *getPassName() const {
100 return "SI Lower control flow instructions";
105 } // End anonymous namespace
107 char SILowerControlFlowPass::ID = 0;
109 FunctionPass *llvm::createSILowerControlFlowPass(TargetMachine &tm) {
110 return new SILowerControlFlowPass(tm);
113 bool SILowerControlFlowPass::shouldSkip(MachineBasicBlock *From,
114 MachineBasicBlock *To) {
116 unsigned NumInstr = 0;
118 for (MachineBasicBlock *MBB = From; MBB != To && !MBB->succ_empty();
119 MBB = *MBB->succ_begin()) {
121 for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
122 NumInstr < SkipThreshold && I != E; ++I) {
124 if (I->isBundle() || !I->isBundled())
125 if (++NumInstr >= SkipThreshold)
133 void SILowerControlFlowPass::Skip(MachineInstr &From, MachineOperand &To) {
135 if (!shouldSkip(*From.getParent()->succ_begin(), To.getMBB()))
138 DebugLoc DL = From.getDebugLoc();
139 BuildMI(*From.getParent(), &From, DL, TII->get(AMDGPU::S_CBRANCH_EXECZ))
141 .addReg(AMDGPU::EXEC);
144 void SILowerControlFlowPass::SkipIfDead(MachineInstr &MI) {
146 MachineBasicBlock &MBB = *MI.getParent();
147 DebugLoc DL = MI.getDebugLoc();
149 if (!shouldSkip(&MBB, &MBB.getParent()->back()))
152 MachineBasicBlock::iterator Insert = &MI;
155 // If the exec mask is non-zero, skip the next two instructions
156 BuildMI(MBB, Insert, DL, TII->get(AMDGPU::S_CBRANCH_EXECNZ))
158 .addReg(AMDGPU::EXEC);
160 // Exec mask is zero: Export to NULL target...
161 BuildMI(MBB, Insert, DL, TII->get(AMDGPU::EXP))
163 .addImm(0x09) // V_008DFC_SQ_EXP_NULL
167 .addReg(AMDGPU::VGPR0)
168 .addReg(AMDGPU::VGPR0)
169 .addReg(AMDGPU::VGPR0)
170 .addReg(AMDGPU::VGPR0);
172 // ... and terminate wavefront
173 BuildMI(MBB, Insert, DL, TII->get(AMDGPU::S_ENDPGM));
176 void SILowerControlFlowPass::If(MachineInstr &MI) {
177 MachineBasicBlock &MBB = *MI.getParent();
178 DebugLoc DL = MI.getDebugLoc();
179 unsigned Reg = MI.getOperand(0).getReg();
180 unsigned Vcc = MI.getOperand(1).getReg();
182 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_AND_SAVEEXEC_B64), Reg)
185 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_XOR_B64), Reg)
186 .addReg(AMDGPU::EXEC)
189 Skip(MI, MI.getOperand(2));
191 MI.eraseFromParent();
194 void SILowerControlFlowPass::Else(MachineInstr &MI) {
195 MachineBasicBlock &MBB = *MI.getParent();
196 DebugLoc DL = MI.getDebugLoc();
197 unsigned Dst = MI.getOperand(0).getReg();
198 unsigned Src = MI.getOperand(1).getReg();
200 BuildMI(MBB, MBB.getFirstNonPHI(), DL,
201 TII->get(AMDGPU::S_OR_SAVEEXEC_B64), Dst)
202 .addReg(Src); // Saved EXEC
204 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_XOR_B64), AMDGPU::EXEC)
205 .addReg(AMDGPU::EXEC)
208 Skip(MI, MI.getOperand(2));
210 MI.eraseFromParent();
213 void SILowerControlFlowPass::Break(MachineInstr &MI) {
214 MachineBasicBlock &MBB = *MI.getParent();
215 DebugLoc DL = MI.getDebugLoc();
217 unsigned Dst = MI.getOperand(0).getReg();
218 unsigned Src = MI.getOperand(1).getReg();
220 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_OR_B64), Dst)
221 .addReg(AMDGPU::EXEC)
224 MI.eraseFromParent();
227 void SILowerControlFlowPass::IfBreak(MachineInstr &MI) {
228 MachineBasicBlock &MBB = *MI.getParent();
229 DebugLoc DL = MI.getDebugLoc();
231 unsigned Dst = MI.getOperand(0).getReg();
232 unsigned Vcc = MI.getOperand(1).getReg();
233 unsigned Src = MI.getOperand(2).getReg();
235 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_OR_B64), Dst)
239 MI.eraseFromParent();
242 void SILowerControlFlowPass::ElseBreak(MachineInstr &MI) {
243 MachineBasicBlock &MBB = *MI.getParent();
244 DebugLoc DL = MI.getDebugLoc();
246 unsigned Dst = MI.getOperand(0).getReg();
247 unsigned Saved = MI.getOperand(1).getReg();
248 unsigned Src = MI.getOperand(2).getReg();
250 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_OR_B64), Dst)
254 MI.eraseFromParent();
257 void SILowerControlFlowPass::Loop(MachineInstr &MI) {
258 MachineBasicBlock &MBB = *MI.getParent();
259 DebugLoc DL = MI.getDebugLoc();
260 unsigned Src = MI.getOperand(0).getReg();
262 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_ANDN2_B64), AMDGPU::EXEC)
263 .addReg(AMDGPU::EXEC)
266 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_CBRANCH_EXECNZ))
267 .addOperand(MI.getOperand(1))
268 .addReg(AMDGPU::EXEC);
270 MI.eraseFromParent();
273 void SILowerControlFlowPass::EndCf(MachineInstr &MI) {
274 MachineBasicBlock &MBB = *MI.getParent();
275 DebugLoc DL = MI.getDebugLoc();
276 unsigned Reg = MI.getOperand(0).getReg();
278 BuildMI(MBB, MBB.getFirstNonPHI(), DL,
279 TII->get(AMDGPU::S_OR_B64), AMDGPU::EXEC)
280 .addReg(AMDGPU::EXEC)
283 MI.eraseFromParent();
286 void SILowerControlFlowPass::Branch(MachineInstr &MI) {
287 MachineBasicBlock *Next = MI.getParent()->getNextNode();
288 MachineBasicBlock *Target = MI.getOperand(0).getMBB();
290 MI.eraseFromParent();
295 void SILowerControlFlowPass::Kill(MachineInstr &MI) {
297 MachineBasicBlock &MBB = *MI.getParent();
298 DebugLoc DL = MI.getDebugLoc();
300 // Kill is only allowed in pixel shaders
301 assert(MBB.getParent()->getInfo<SIMachineFunctionInfo>()->ShaderType ==
304 // Clear this pixel from the exec mask if the operand is negative
305 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::V_CMPX_LE_F32_e32), AMDGPU::VCC)
307 .addOperand(MI.getOperand(0));
309 MI.eraseFromParent();
312 void SILowerControlFlowPass::LoadM0(MachineInstr &MI, MachineInstr *MovRel) {
314 MachineBasicBlock &MBB = *MI.getParent();
315 DebugLoc DL = MI.getDebugLoc();
316 MachineBasicBlock::iterator I = MI;
318 unsigned Save = MI.getOperand(1).getReg();
319 unsigned Idx = MI.getOperand(3).getReg();
321 if (AMDGPU::SReg_32RegClass.contains(Idx)) {
322 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_MOV_B32), AMDGPU::M0)
324 MBB.insert(I, MovRel);
325 MI.eraseFromParent();
329 assert(AMDGPU::SReg_64RegClass.contains(Save));
330 assert(AMDGPU::VReg_32RegClass.contains(Idx));
332 // Save the EXEC mask
333 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_MOV_B64), Save)
334 .addReg(AMDGPU::EXEC);
336 // Read the next variant into VCC (lower 32 bits) <- also loop target
337 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::V_READFIRSTLANE_B32_e32), AMDGPU::VCC)
340 // Move index from VCC into M0
341 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_MOV_B32), AMDGPU::M0)
342 .addReg(AMDGPU::VCC);
344 // Compare the just read M0 value to all possible Idx values
345 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::V_CMP_EQ_U32_e32), AMDGPU::VCC)
349 // Update EXEC, save the original EXEC value to VCC
350 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_AND_SAVEEXEC_B64), AMDGPU::VCC)
351 .addReg(AMDGPU::VCC);
353 // Do the actual move
354 MBB.insert(I, MovRel);
356 // Update EXEC, switch all done bits to 0 and all todo bits to 1
357 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_XOR_B64), AMDGPU::EXEC)
358 .addReg(AMDGPU::EXEC)
359 .addReg(AMDGPU::VCC);
361 // Loop back to V_READFIRSTLANE_B32 if there are still variants to cover
362 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_CBRANCH_EXECNZ))
364 .addReg(AMDGPU::EXEC);
367 BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_MOV_B64), AMDGPU::EXEC)
370 MI.eraseFromParent();
373 void SILowerControlFlowPass::IndirectSrc(MachineInstr &MI) {
375 MachineBasicBlock &MBB = *MI.getParent();
376 DebugLoc DL = MI.getDebugLoc();
378 unsigned Dst = MI.getOperand(0).getReg();
379 unsigned Vec = MI.getOperand(2).getReg();
380 unsigned Off = MI.getOperand(4).getImm();
382 MachineInstr *MovRel =
383 BuildMI(*MBB.getParent(), DL, TII->get(AMDGPU::V_MOVRELS_B32_e32), Dst)
384 .addReg(TRI->getSubReg(Vec, AMDGPU::sub0) + Off)
385 .addReg(AMDGPU::M0, RegState::Implicit)
386 .addReg(Vec, RegState::Implicit);
391 void SILowerControlFlowPass::IndirectDst(MachineInstr &MI) {
393 MachineBasicBlock &MBB = *MI.getParent();
394 DebugLoc DL = MI.getDebugLoc();
396 unsigned Dst = MI.getOperand(0).getReg();
397 unsigned Off = MI.getOperand(4).getImm();
398 unsigned Val = MI.getOperand(5).getReg();
400 MachineInstr *MovRel =
401 BuildMI(*MBB.getParent(), DL, TII->get(AMDGPU::V_MOVRELD_B32_e32))
402 .addReg(TRI->getSubReg(Dst, AMDGPU::sub0) + Off, RegState::Define)
404 .addReg(AMDGPU::M0, RegState::Implicit)
405 .addReg(Dst, RegState::Implicit);
410 bool SILowerControlFlowPass::runOnMachineFunction(MachineFunction &MF) {
412 bool HaveKill = false;
413 bool NeedWQM = false;
416 for (MachineFunction::iterator BI = MF.begin(), BE = MF.end();
419 MachineBasicBlock &MBB = *BI;
420 for (MachineBasicBlock::iterator I = MBB.begin(), Next = llvm::next(I);
421 I != MBB.end(); I = Next) {
423 Next = llvm::next(I);
424 MachineInstr &MI = *I;
425 switch (MI.getOpcode()) {
432 case AMDGPU::SI_ELSE:
436 case AMDGPU::SI_BREAK:
440 case AMDGPU::SI_IF_BREAK:
444 case AMDGPU::SI_ELSE_BREAK:
448 case AMDGPU::SI_LOOP:
453 case AMDGPU::SI_END_CF:
454 if (--Depth == 0 && HaveKill) {
461 case AMDGPU::SI_KILL:
469 case AMDGPU::S_BRANCH:
473 case AMDGPU::SI_INDIRECT_SRC:
477 case AMDGPU::SI_INDIRECT_DST_V2:
478 case AMDGPU::SI_INDIRECT_DST_V4:
479 case AMDGPU::SI_INDIRECT_DST_V8:
480 case AMDGPU::SI_INDIRECT_DST_V16:
484 case AMDGPU::V_INTERP_P1_F32:
485 case AMDGPU::V_INTERP_P2_F32:
486 case AMDGPU::V_INTERP_MOV_F32:
495 MachineBasicBlock &MBB = MF.front();
496 BuildMI(MBB, MBB.getFirstNonPHI(), DebugLoc(), TII->get(AMDGPU::S_WQM_B64),
497 AMDGPU::EXEC).addReg(AMDGPU::EXEC);