lib/Target/ARM/Thumb2ITBlockPass.cpp

   1 //===-- Thumb2ITBlockPass.cpp - Insert Thumb IT blocks ----------*- C++ -*-===//
   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 #define DEBUG_TYPE "thumb2-it"
  11 #include "ARM.h"
  12 #include "ARMMachineFunctionInfo.h"
  13 #include "Thumb2InstrInfo.h"
  14 #include "llvm/CodeGen/MachineInstr.h"
  15 #include "llvm/CodeGen/MachineInstrBuilder.h"
  16 #include "llvm/CodeGen/MachineFunctionPass.h"
  17 #include "llvm/ADT/SmallSet.h"
  18 #include "llvm/ADT/Statistic.h"
  19 using namespace llvm;
  20
  21 STATISTIC(NumITs,        "Number of IT blocks inserted");
  22 STATISTIC(NumMovedInsts, "Number of predicated instructions moved");
  23
  24 namespace {
  25   class Thumb2ITBlockPass : public MachineFunctionPass {
  26     bool PreRegAlloc;
  27
  28   public:
  29     static char ID;
  30     Thumb2ITBlockPass() : MachineFunctionPass(ID) {}
  31
  32     const Thumb2InstrInfo *TII;
  33     const TargetRegisterInfo *TRI;
  34     ARMFunctionInfo *AFI;
  35
  36     virtual bool runOnMachineFunction(MachineFunction &Fn);
  37
  38     virtual const char *getPassName() const {
  39       return "Thumb IT blocks insertion pass";
  40     }
  41
  42   private:
  43     bool MoveCopyOutOfITBlock(MachineInstr *MI,
  44                               ARMCC::CondCodes CC, ARMCC::CondCodes OCC,
  45                               SmallSet<unsigned, 4> &Defs,
  46                               SmallSet<unsigned, 4> &Uses);
  47     bool InsertITInstructions(MachineBasicBlock &MBB);
  48   };
  49   char Thumb2ITBlockPass::ID = 0;
  50 }
  51
  52 /// TrackDefUses - Tracking what registers are being defined and used by
  53 /// instructions in the IT block. This also tracks "dependencies", i.e. uses
  54 /// in the IT block that are defined before the IT instruction.
  55 static void TrackDefUses(MachineInstr *MI,
  56                          SmallSet<unsigned, 4> &Defs,
  57                          SmallSet<unsigned, 4> &Uses,
  58                          const TargetRegisterInfo *TRI) {
  59   SmallVector<unsigned, 4> LocalDefs;
  60   SmallVector<unsigned, 4> LocalUses;
  61
  62   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
  63     MachineOperand &MO = MI->getOperand(i);
  64     if (!MO.isReg())
  65       continue;
  66     unsigned Reg = MO.getReg();
  67     if (!Reg || Reg == ARM::ITSTATE || Reg == ARM::SP)
  68       continue;
  69     if (MO.isUse())
  70       LocalUses.push_back(Reg);
  71     else
  72       LocalDefs.push_back(Reg);
  73   }
  74
  75   for (unsigned i = 0, e = LocalUses.size(); i != e; ++i) {
  76     unsigned Reg = LocalUses[i];
  77     Uses.insert(Reg);
  78     for (const unsigned *Subreg = TRI->getSubRegisters(Reg);
  79          *Subreg; ++Subreg)
  80       Uses.insert(*Subreg);
  81   }
  82
  83   for (unsigned i = 0, e = LocalDefs.size(); i != e; ++i) {
  84     unsigned Reg = LocalDefs[i];
  85     Defs.insert(Reg);
  86     for (const unsigned *Subreg = TRI->getSubRegisters(Reg);
  87          *Subreg; ++Subreg)
  88       Defs.insert(*Subreg);
  89     if (Reg == ARM::CPSR)
  90       continue;
  91   }
  92 }
  93
  94 static bool isCopy(MachineInstr *MI) {
  95   switch (MI->getOpcode()) {
  96   default:
  97     return false;
  98   case ARM::MOVr:
  99   case ARM::MOVr_TC:
 100   case ARM::tMOVr:
 101   case ARM::t2MOVr:
 102     return true;
 103   }
 104 }
 105
 106 bool
 107 Thumb2ITBlockPass::MoveCopyOutOfITBlock(MachineInstr *MI,
 108                                       ARMCC::CondCodes CC, ARMCC::CondCodes OCC,
 109                                         SmallSet<unsigned, 4> &Defs,
 110                                         SmallSet<unsigned, 4> &Uses) {
 111   if (!isCopy(MI))
 112     return false;
 113   // llvm models select's as two-address instructions. That means a copy
 114   // is inserted before a t2MOVccr, etc. If the copy is scheduled in
 115   // between selects we would end up creating multiple IT blocks.
 116   assert(MI->getOperand(0).getSubReg() == 0 &&
 117          MI->getOperand(1).getSubReg() == 0 &&
 118          "Sub-register indices still around?");
 119
 120   unsigned DstReg = MI->getOperand(0).getReg();
 121   unsigned SrcReg = MI->getOperand(1).getReg();
 122
 123   // First check if it's safe to move it.
 124   if (Uses.count(DstReg) || Defs.count(SrcReg))
 125     return false;
 126
 127   // If the CPSR is defined by this copy, then we don't want to move it. E.g.,
 128   // if we have:
 129   //
 130   //   movs  r1, r1
 131   //   rsb   r1, 0
 132   //   movs  r2, r2
 133   //   rsb   r2, 0
 134   //
 135   // we don't want this to be converted to:
 136   //
 137   //   movs  r1, r1
 138   //   movs  r2, r2
 139   //   itt   mi
 140   //   rsb   r1, 0
 141   //   rsb   r2, 0
 142   //
 143   //
 144   for (unsigned I = 0, E = MI->getNumOperands(); I != E; ++I)
 145     if (MI->getOperand(I).isReg() && MI->getOperand(I).getReg() == ARM::CPSR &&
 146         MI->getOperand(I).isDef())
 147       return false;
 148
 149   // Then peek at the next instruction to see if it's predicated on CC or OCC.
 150   // If not, then there is nothing to be gained by moving the copy.
 151   MachineBasicBlock::iterator I = MI; ++I;
 152   MachineBasicBlock::iterator E = MI->getParent()->end();
 153   while (I != E && I->isDebugValue())
 154     ++I;
 155   if (I != E) {
 156     unsigned NPredReg = 0;
 157     ARMCC::CondCodes NCC = llvm::getITInstrPredicate(I, NPredReg);
 158     if (NCC == CC || NCC == OCC)
 159       return true;
 160   }
 161   return false;
 162 }
 163
 164 bool Thumb2ITBlockPass::InsertITInstructions(MachineBasicBlock &MBB) {
 165   bool Modified = false;
 166
 167   SmallSet<unsigned, 4> Defs;
 168   SmallSet<unsigned, 4> Uses;
 169   MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
 170   while (MBBI != E) {
 171     MachineInstr *MI = &*MBBI;
 172     DebugLoc dl = MI->getDebugLoc();
 173     unsigned PredReg = 0;
 174     ARMCC::CondCodes CC = llvm::getITInstrPredicate(MI, PredReg);
 175     if (CC == ARMCC::AL) {
 176       ++MBBI;
 177       continue;
 178     }
 179
 180     Defs.clear();
 181     Uses.clear();
 182     TrackDefUses(MI, Defs, Uses, TRI);
 183
 184     // Insert an IT instruction.
 185     MachineInstrBuilder MIB = BuildMI(MBB, MBBI, dl, TII->get(ARM::t2IT))
 186       .addImm(CC);
 187
 188     // Add implicit use of ITSTATE to IT block instructions.
 189     MI->addOperand(MachineOperand::CreateReg(ARM::ITSTATE, false/*ifDef*/,
 190                                              true/*isImp*/, false/*isKill*/));
 191
 192     MachineInstr *LastITMI = MI;
 193     MachineBasicBlock::iterator InsertPos = MIB;
 194     ++MBBI;
 195
 196     // Form IT block.
 197     ARMCC::CondCodes OCC = ARMCC::getOppositeCondition(CC);
 198     unsigned Mask = 0, Pos = 3;
 199     // Branches, including tricky ones like LDM_RET, need to end an IT
 200     // block so check the instruction we just put in the block.
 201     for (; MBBI != E && Pos &&
 202            (!MI->getDesc().isBranch() && !MI->getDesc().isReturn()) ; ++MBBI) {
 203       if (MBBI->isDebugValue())
 204         continue;
 205
 206       MachineInstr *NMI = &*MBBI;
 207       MI = NMI;
 208
 209       unsigned NPredReg = 0;
 210       ARMCC::CondCodes NCC = llvm::getITInstrPredicate(NMI, NPredReg);
 211       if (NCC == CC || NCC == OCC) {
 212         Mask |= (NCC & 1) << Pos;
 213         // Add implicit use of ITSTATE.
 214         NMI->addOperand(MachineOperand::CreateReg(ARM::ITSTATE, false/*ifDef*/,
 215                                                true/*isImp*/, false/*isKill*/));
 216         LastITMI = NMI;
 217       } else {
 218         if (NCC == ARMCC::AL &&
 219             MoveCopyOutOfITBlock(NMI, CC, OCC, Defs, Uses)) {
 220           --MBBI;
 221           MBB.remove(NMI);
 222           MBB.insert(InsertPos, NMI);
 223           ++NumMovedInsts;
 224           continue;
 225         }
 226         break;
 227       }
 228       TrackDefUses(NMI, Defs, Uses, TRI);
 229       --Pos;
 230     }
 231
 232     // Finalize IT mask.
 233     Mask |= (1 << Pos);
 234     // Tag along (firstcond[0] << 4) with the mask.
 235     Mask |= (CC & 1) << 4;
 236     MIB.addImm(Mask);
 237
 238     // Last instruction in IT block kills ITSTATE.
 239     LastITMI->findRegisterUseOperand(ARM::ITSTATE)->setIsKill();
 240
 241     Modified = true;
 242     ++NumITs;
 243   }
 244
 245   return Modified;
 246 }
 247
 248 bool Thumb2ITBlockPass::runOnMachineFunction(MachineFunction &Fn) {
 249   const TargetMachine &TM = Fn.getTarget();
 250   AFI = Fn.getInfo<ARMFunctionInfo>();
 251   TII = static_cast<const Thumb2InstrInfo*>(TM.getInstrInfo());
 252   TRI = TM.getRegisterInfo();
 253
 254   if (!AFI->isThumbFunction())
 255     return false;
 256
 257   bool Modified = false;
 258   for (MachineFunction::iterator MFI = Fn.begin(), E = Fn.end(); MFI != E; ) {
 259     MachineBasicBlock &MBB = *MFI;
 260     ++MFI;
 261     Modified |= InsertITInstructions(MBB);
 262   }
 263
 264   if (Modified)
 265     AFI->setHasITBlocks(true);
 266
 267   return Modified;
 268 }
 269
 270 /// createThumb2ITBlockPass - Returns an instance of the Thumb2 IT blocks
 271 /// insertion pass.
 272 FunctionPass *llvm::createThumb2ITBlockPass() {
 273   return new Thumb2ITBlockPass();
 274 }