lib/Target/R600/SILowerControlFlow.cpp

   1 //===-- SILowerControlFlow.cpp - Use predicates for control flow ----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 /// \file
  11 /// \brief This pass lowers the pseudo control flow instructions to real
  12 /// machine instructions.
  13 ///
  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.
  22 ///
  23 /// For example:
  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
  29 /// SI_END_CF %SGPR0
  30 ///
  31 /// becomes:
  32 ///
  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
  38 ///                                   // EXEC are zero.
  39 /// %VGPR0 = V_ADD_F32 %VGPR0, %VGPR0 // Do the IF block of the branch
  40 ///
  41 /// label0:
  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
  47 /// label1:
  48 /// %EXEC = S_OR_B64 %EXEC, %SGPR0     // Re-enable saved exec mask bits
  49 //===----------------------------------------------------------------------===//
  50
  51 #include "AMDGPU.h"
  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"
  58
  59 using namespace llvm;
  60
  61 namespace {
  62
  63 class SILowerControlFlowPass : public MachineFunctionPass {
  64
  65 private:
  66   static const unsigned SkipThreshold = 12;
  67
  68   static char ID;
  69   const TargetInstrInfo *TII;
  70
  71   bool shouldSkip(MachineBasicBlock *From, MachineBasicBlock *To);
  72
  73   void Skip(MachineInstr &From, MachineOperand &To);
  74   void SkipIfDead(MachineInstr &MI);
  75
  76   void If(MachineInstr &MI);
  77   void Else(MachineInstr &MI);
  78   void Break(MachineInstr &MI);
  79   void IfBreak(MachineInstr &MI);
  80   void ElseBreak(MachineInstr &MI);
  81   void Loop(MachineInstr &MI);
  82   void EndCf(MachineInstr &MI);
  83
  84   void Kill(MachineInstr &MI);
  85   void Branch(MachineInstr &MI);
  86
  87 public:
  88   SILowerControlFlowPass(TargetMachine &tm) :
  89     MachineFunctionPass(ID), TII(tm.getInstrInfo()) { }
  90
  91   virtual bool runOnMachineFunction(MachineFunction &MF);
  92
  93   const char *getPassName() const {
  94     return "SI Lower control flow instructions";
  95   }
  96
  97 };
  98
  99 } // End anonymous namespace
 100
 101 char SILowerControlFlowPass::ID = 0;
 102
 103 FunctionPass *llvm::createSILowerControlFlowPass(TargetMachine &tm) {
 104   return new SILowerControlFlowPass(tm);
 105 }
 106
 107 bool SILowerControlFlowPass::shouldSkip(MachineBasicBlock *From,
 108                                         MachineBasicBlock *To) {
 109
 110   unsigned NumInstr = 0;
 111
 112   for (MachineBasicBlock *MBB = From; MBB != To && !MBB->succ_empty();
 113        MBB = *MBB->succ_begin()) {
 114
 115     for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
 116          NumInstr < SkipThreshold && I != E; ++I) {
 117
 118       if (I->isBundle() || !I->isBundled())
 119         if (++NumInstr >= SkipThreshold)
 120           return true;
 121     }
 122   }
 123
 124   return false;
 125 }
 126
 127 void SILowerControlFlowPass::Skip(MachineInstr &From, MachineOperand &To) {
 128
 129   if (!shouldSkip(*From.getParent()->succ_begin(), To.getMBB()))
 130     return;
 131
 132   DebugLoc DL = From.getDebugLoc();
 133   BuildMI(*From.getParent(), &From, DL, TII->get(AMDGPU::S_CBRANCH_EXECZ))
 134           .addOperand(To)
 135           .addReg(AMDGPU::EXEC);
 136 }
 137
 138 void SILowerControlFlowPass::SkipIfDead(MachineInstr &MI) {
 139
 140   MachineBasicBlock &MBB = *MI.getParent();
 141   DebugLoc DL = MI.getDebugLoc();
 142
 143   if (!shouldSkip(&MBB, &MBB.getParent()->back()))
 144     return;
 145
 146   MachineBasicBlock::iterator Insert = &MI;
 147   ++Insert;
 148
 149   // If the exec mask is non-zero, skip the next two instructions
 150   BuildMI(MBB, Insert, DL, TII->get(AMDGPU::S_CBRANCH_EXECNZ))
 151           .addImm(3)
 152           .addReg(AMDGPU::EXEC);
 153
 154   // Exec mask is zero: Export to NULL target...
 155   BuildMI(MBB, Insert, DL, TII->get(AMDGPU::EXP))
 156           .addImm(0)
 157           .addImm(0x09) // V_008DFC_SQ_EXP_NULL
 158           .addImm(0)
 159           .addImm(1)
 160           .addImm(1)
 161           .addReg(AMDGPU::SREG_LIT_0)
 162           .addReg(AMDGPU::SREG_LIT_0)
 163           .addReg(AMDGPU::SREG_LIT_0)
 164           .addReg(AMDGPU::SREG_LIT_0);
 165
 166   // ... and terminate wavefront
 167   BuildMI(MBB, Insert, DL, TII->get(AMDGPU::S_ENDPGM));
 168 }
 169
 170 void SILowerControlFlowPass::If(MachineInstr &MI) {
 171   MachineBasicBlock &MBB = *MI.getParent();
 172   DebugLoc DL = MI.getDebugLoc();
 173   unsigned Reg = MI.getOperand(0).getReg();
 174   unsigned Vcc = MI.getOperand(1).getReg();
 175
 176   BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_AND_SAVEEXEC_B64), Reg)
 177           .addReg(Vcc);
 178
 179   BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_XOR_B64), Reg)
 180           .addReg(AMDGPU::EXEC)
 181           .addReg(Reg);
 182
 183   Skip(MI, MI.getOperand(2));
 184
 185   MI.eraseFromParent();
 186 }
 187
 188 void SILowerControlFlowPass::Else(MachineInstr &MI) {
 189   MachineBasicBlock &MBB = *MI.getParent();
 190   DebugLoc DL = MI.getDebugLoc();
 191   unsigned Dst = MI.getOperand(0).getReg();
 192   unsigned Src = MI.getOperand(1).getReg();
 193
 194   BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_OR_SAVEEXEC_B64), Dst)
 195           .addReg(Src); // Saved EXEC
 196
 197   BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_XOR_B64), AMDGPU::EXEC)
 198           .addReg(AMDGPU::EXEC)
 199           .addReg(Dst);
 200
 201   Skip(MI, MI.getOperand(2));
 202
 203   MI.eraseFromParent();
 204 }
 205
 206 void SILowerControlFlowPass::Break(MachineInstr &MI) {
 207   MachineBasicBlock &MBB = *MI.getParent();
 208   DebugLoc DL = MI.getDebugLoc();
 209
 210   unsigned Dst = MI.getOperand(0).getReg();
 211   unsigned Src = MI.getOperand(1).getReg();
 212
 213   BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_OR_B64), Dst)
 214           .addReg(AMDGPU::EXEC)
 215           .addReg(Src);
 216
 217   MI.eraseFromParent();
 218 }
 219
 220 void SILowerControlFlowPass::IfBreak(MachineInstr &MI) {
 221   MachineBasicBlock &MBB = *MI.getParent();
 222   DebugLoc DL = MI.getDebugLoc();
 223
 224   unsigned Dst = MI.getOperand(0).getReg();
 225   unsigned Vcc = MI.getOperand(1).getReg();
 226   unsigned Src = MI.getOperand(2).getReg();
 227
 228   BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_OR_B64), Dst)
 229           .addReg(Vcc)
 230           .addReg(Src);
 231
 232   MI.eraseFromParent();
 233 }
 234
 235 void SILowerControlFlowPass::ElseBreak(MachineInstr &MI) {
 236   MachineBasicBlock &MBB = *MI.getParent();
 237   DebugLoc DL = MI.getDebugLoc();
 238
 239   unsigned Dst = MI.getOperand(0).getReg();
 240   unsigned Saved = MI.getOperand(1).getReg();
 241   unsigned Src = MI.getOperand(2).getReg();
 242
 243   BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_OR_B64), Dst)
 244           .addReg(Saved)
 245           .addReg(Src);
 246
 247   MI.eraseFromParent();
 248 }
 249
 250 void SILowerControlFlowPass::Loop(MachineInstr &MI) {
 251   MachineBasicBlock &MBB = *MI.getParent();
 252   DebugLoc DL = MI.getDebugLoc();
 253   unsigned Src = MI.getOperand(0).getReg();
 254
 255   BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_ANDN2_B64), AMDGPU::EXEC)
 256           .addReg(AMDGPU::EXEC)
 257           .addReg(Src);
 258
 259   BuildMI(MBB, &MI, DL, TII->get(AMDGPU::S_CBRANCH_EXECNZ))
 260           .addOperand(MI.getOperand(1))
 261           .addReg(AMDGPU::EXEC);
 262
 263   MI.eraseFromParent();
 264 }
 265
 266 void SILowerControlFlowPass::EndCf(MachineInstr &MI) {
 267   MachineBasicBlock &MBB = *MI.getParent();
 268   DebugLoc DL = MI.getDebugLoc();
 269   unsigned Reg = MI.getOperand(0).getReg();
 270
 271   BuildMI(MBB, MBB.getFirstNonPHI(), DL,
 272           TII->get(AMDGPU::S_OR_B64), AMDGPU::EXEC)
 273           .addReg(AMDGPU::EXEC)
 274           .addReg(Reg);
 275
 276   MI.eraseFromParent();
 277 }
 278
 279 void SILowerControlFlowPass::Branch(MachineInstr &MI) {
 280   MachineBasicBlock *Next = MI.getParent()->getNextNode();
 281   MachineBasicBlock *Target = MI.getOperand(0).getMBB();
 282   if (Target == Next)
 283     MI.eraseFromParent();
 284   else
 285     assert(0);
 286 }
 287
 288 void SILowerControlFlowPass::Kill(MachineInstr &MI) {
 289
 290   MachineBasicBlock &MBB = *MI.getParent();
 291   DebugLoc DL = MI.getDebugLoc();
 292
 293   // Kill is only allowed in pixel shaders
 294   assert(MBB.getParent()->getInfo<SIMachineFunctionInfo>()->ShaderType ==
 295          ShaderType::PIXEL);
 296
 297   // Clear this pixel from the exec mask if the operand is negative
 298   BuildMI(MBB, &MI, DL, TII->get(AMDGPU::V_CMPX_LE_F32_e32), AMDGPU::VCC)
 299           .addReg(AMDGPU::SREG_LIT_0)
 300           .addOperand(MI.getOperand(0));
 301
 302   MI.eraseFromParent();
 303 }
 304
 305 bool SILowerControlFlowPass::runOnMachineFunction(MachineFunction &MF) {
 306
 307   bool HaveKill = false;
 308   unsigned Depth = 0;
 309
 310   for (MachineFunction::iterator BI = MF.begin(), BE = MF.end();
 311        BI != BE; ++BI) {
 312
 313     MachineBasicBlock &MBB = *BI;
 314     for (MachineBasicBlock::iterator I = MBB.begin(), Next = llvm::next(I);
 315          I != MBB.end(); I = Next) {
 316
 317       Next = llvm::next(I);
 318       MachineInstr &MI = *I;
 319       switch (MI.getOpcode()) {
 320         default: break;
 321         case AMDGPU::SI_IF:
 322           ++Depth;
 323           If(MI);
 324           break;
 325
 326         case AMDGPU::SI_ELSE:
 327           Else(MI);
 328           break;
 329
 330         case AMDGPU::SI_BREAK:
 331           Break(MI);
 332           break;
 333
 334         case AMDGPU::SI_IF_BREAK:
 335           IfBreak(MI);
 336           break;
 337
 338         case AMDGPU::SI_ELSE_BREAK:
 339           ElseBreak(MI);
 340           break;
 341
 342         case AMDGPU::SI_LOOP:
 343           ++Depth;
 344           Loop(MI);
 345           break;
 346
 347         case AMDGPU::SI_END_CF:
 348           if (--Depth == 0 && HaveKill) {
 349             SkipIfDead(MI);
 350             HaveKill = false;
 351           }
 352           EndCf(MI);
 353           break;
 354
 355         case AMDGPU::SI_KILL:
 356           if (Depth == 0)
 357             SkipIfDead(MI);
 358           else
 359             HaveKill = true;
 360           Kill(MI);
 361           break;
 362
 363         case AMDGPU::S_BRANCH:
 364           Branch(MI);
 365           break;
 366       }
 367     }
 368   }
 369
 370   return true;
 371 }