Remove pointless variable LastDef.
[oota-llvm.git] / lib / Target / ARM / Thumb2ITBlockPass.cpp
index f36d4ef7567ee650fe9b0f115d55ac6054e73221..0faf509ffd19ded46a48fdd2f95fb5d4d6239309 100644 (file)
 #include "llvm/CodeGen/MachineInstr.h"
 #include "llvm/CodeGen/MachineInstrBuilder.h"
 #include "llvm/CodeGen/MachineFunctionPass.h"
+#include "llvm/ADT/SmallSet.h"
 #include "llvm/ADT/Statistic.h"
 using namespace llvm;
 
-STATISTIC(NumITs,     "Number of IT blocks inserted");
+STATISTIC(NumITs,        "Number of IT blocks inserted");
+STATISTIC(NumMovedInsts, "Number of predicated instructions moved");
 
 namespace {
-  struct Thumb2ITBlockPass : public MachineFunctionPass {
+  class Thumb2ITBlockPass : public MachineFunctionPass {
+    bool PreRegAlloc;
+
+  public:
     static char ID;
-    Thumb2ITBlockPass() : MachineFunctionPass(&ID) {}
+    Thumb2ITBlockPass(bool PreRA) :
+      MachineFunctionPass(&ID), PreRegAlloc(PreRA) {}
 
     const Thumb2InstrInfo *TII;
+    const TargetRegisterInfo *TRI;
     ARMFunctionInfo *AFI;
 
     virtual bool runOnMachineFunction(MachineFunction &Fn);
@@ -34,61 +41,362 @@ namespace {
     }
 
   private:
+    bool MoveCPSRUseUp(MachineBasicBlock &MBB,
+                       MachineBasicBlock::iterator MBBI,
+                       MachineBasicBlock::iterator E,
+                       unsigned PredReg,
+                       ARMCC::CondCodes CC, ARMCC::CondCodes OCC,
+                       bool &Done);
+
+    void FindITBlockRanges(MachineBasicBlock &MBB,
+                           SmallVector<MachineInstr*,4> &FirstUses,
+                           SmallVector<MachineInstr*,4> &LastUses);
+    bool InsertITBlock(MachineInstr *First, MachineInstr *Last);
     bool InsertITBlocks(MachineBasicBlock &MBB);
+    bool MoveCopyOutOfITBlock(MachineInstr *MI,
+                              ARMCC::CondCodes CC, ARMCC::CondCodes OCC,
+                              SmallSet<unsigned, 4> &Defs,
+                              SmallSet<unsigned, 4> &Uses);
+    bool InsertITInstructions(MachineBasicBlock &MBB);
   };
   char Thumb2ITBlockPass::ID = 0;
 }
 
-static ARMCC::CondCodes getPredicate(const MachineInstr *MI, unsigned &PredReg){
-  unsigned Opc = MI->getOpcode();
-  if (Opc == ARM::tBcc || Opc == ARM::t2Bcc)
-    return ARMCC::AL;
-  return llvm::getInstrPredicate(MI, PredReg);
+bool
+Thumb2ITBlockPass::MoveCPSRUseUp(MachineBasicBlock &MBB,
+                                 MachineBasicBlock::iterator MBBI,
+                                 MachineBasicBlock::iterator E,
+                                 unsigned PredReg,
+                                 ARMCC::CondCodes CC, ARMCC::CondCodes OCC,
+                                 bool &Done) {
+  SmallSet<unsigned, 4> Defs, Uses;
+  MachineBasicBlock::iterator I = MBBI;
+  // Look for next CPSR use by scanning up to 4 instructions.
+  for (unsigned i = 0; i < 4; ++i) {
+    MachineInstr *MI = &*I;
+    unsigned MPredReg = 0;
+    ARMCC::CondCodes MCC = llvm::getITInstrPredicate(MI, MPredReg);
+    if (MCC != ARMCC::AL) {
+      if (MPredReg != PredReg || (MCC != CC && MCC != OCC))
+        return false;
+
+      // Check if the instruction is using any register that's defined
+      // below the previous predicated instruction. Also return false if
+      // it defines any register which is used in between.
+      for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
+        const MachineOperand &MO = MI->getOperand(i);
+        if (!MO.isReg())
+          continue;
+        unsigned Reg = MO.getReg();
+        if (!Reg)
+          continue;
+        if (MO.isDef()) {
+          if (Reg == PredReg || Uses.count(Reg))
+            return false;
+        } else {
+          if (Defs.count(Reg))
+            return false;
+        }
+      }
+
+      Done = (I == E);
+      MBB.remove(MI);
+      MBB.insert(MBBI, MI);
+      ++NumMovedInsts;
+      return true;
+    }
+
+    for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
+      const MachineOperand &MO = MI->getOperand(i);
+      if (!MO.isReg())
+        continue;
+      unsigned Reg = MO.getReg();
+      if (!Reg)
+        continue;
+      if (MO.isDef()) {
+        if (Reg == PredReg)
+          return false;
+        Defs.insert(Reg);
+      } else
+        Uses.insert(Reg);
+    }
+
+    if (I == E)
+      break;
+    ++I;
+  }
+  return false;
+}
+
+static bool isCPSRLiveout(MachineBasicBlock &MBB) {
+  for (MachineBasicBlock::succ_iterator I = MBB.succ_begin(),
+         E = MBB.succ_end(); I != E; ++I) {
+    if ((*I)->isLiveIn(ARM::CPSR))
+      return true;
+  }
+  return false;
+}
+
+void Thumb2ITBlockPass::FindITBlockRanges(MachineBasicBlock &MBB,
+                                       SmallVector<MachineInstr*,4> &FirstUses,
+                                       SmallVector<MachineInstr*,4> &LastUses) {
+  bool SeenUse = false;
+  MachineOperand *LastUse = 0;
+  MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
+  while (MBBI != E) {
+    MachineInstr *MI = &*MBBI;
+    ++MBBI;
+
+    MachineOperand *Def = 0;
+    MachineOperand *Use = 0;
+    for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
+      MachineOperand &MO = MI->getOperand(i);
+      if (!MO.isReg() || MO.getReg() != ARM::CPSR)
+        continue;
+      if (MO.isDef()) {
+        assert(Def == 0 && "Multiple defs of CPSR?");
+        Def = &MO;
+      } else {
+        assert(Use == 0 && "Multiple uses of CPSR?");
+        Use = &MO;
+      }
+    }
+
+    if (Use) {
+      LastUse = Use;
+      if (!SeenUse) {
+        FirstUses.push_back(MI);
+        SeenUse = true;
+      }
+    }
+    if (Def) {
+      if (LastUse) {
+        LastUses.push_back(LastUse->getParent());
+        LastUse = 0;
+      }
+      SeenUse = false;
+    }
+  }
+
+  if (LastUse) {
+    // Is the last use a kill?
+    if (isCPSRLiveout(MBB))
+      LastUses.push_back(0);
+    else
+      LastUses.push_back(LastUse->getParent());
+  }
+}
+
+bool Thumb2ITBlockPass::InsertITBlock(MachineInstr *First, MachineInstr *Last) {
+  if (First == Last)
+    return false;
+
+  bool Modified = false;
+  MachineBasicBlock *MBB = First->getParent();
+  MachineBasicBlock::iterator MBBI = First;
+  MachineBasicBlock::iterator E = Last;
+
+  if (First->getDesc().isBranch() || First->getDesc().isReturn())
+    return false;
+
+  unsigned PredReg = 0;
+  ARMCC::CondCodes CC = llvm::getITInstrPredicate(First, PredReg);
+  if (CC == ARMCC::AL)
+    return Modified;
+
+  // Move uses of the CPSR together if possible.
+  ARMCC::CondCodes OCC = ARMCC::getOppositeCondition(CC);
+
+  do {
+    ++MBBI;
+    if (MBBI->getDesc().isBranch() || MBBI->getDesc().isReturn())
+      return Modified;
+    MachineInstr *NMI = &*MBBI;
+    unsigned NPredReg = 0;
+    ARMCC::CondCodes NCC = llvm::getITInstrPredicate(NMI, NPredReg);
+    if (NCC != CC && NCC != OCC) {
+      if (NCC != ARMCC::AL)
+        return Modified;
+      assert(MBBI != E);
+      bool Done = false;
+      if (!MoveCPSRUseUp(*MBB, MBBI, E, PredReg, CC, OCC, Done))
+        return Modified;
+      Modified = true;
+      if (Done)
+        MBBI = E;
+    }
+  } while (MBBI != E);
+  return true;
 }
 
 bool Thumb2ITBlockPass::InsertITBlocks(MachineBasicBlock &MBB) {
+  SmallVector<MachineInstr*, 4> FirstUses;
+  SmallVector<MachineInstr*, 4> LastUses;
+  FindITBlockRanges(MBB, FirstUses, LastUses);
+  assert(FirstUses.size() == LastUses.size() && "Incorrect range information!");
+
+  bool Modified = false;
+  for (unsigned i = 0, e = FirstUses.size(); i != e; ++i) {
+    if (LastUses[i] == 0)
+      // Must be the last pair where CPSR is live out of the block.
+      return Modified;
+    Modified |= InsertITBlock(FirstUses[i], LastUses[i]);
+  }
+  return Modified;
+}
+
+/// TrackDefUses - Tracking what registers are being defined and used by
+/// instructions in the IT block. This also tracks "dependencies", i.e. uses
+/// in the IT block that are defined before the IT instruction.
+static void TrackDefUses(MachineInstr *MI,
+                         SmallSet<unsigned, 4> &Defs,
+                         SmallSet<unsigned, 4> &Uses,
+                         const TargetRegisterInfo *TRI) {
+  SmallVector<unsigned, 4> LocalDefs;
+  SmallVector<unsigned, 4> LocalUses;
+
+  for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
+    MachineOperand &MO = MI->getOperand(i);
+    if (!MO.isReg())
+      continue;
+    unsigned Reg = MO.getReg();
+    if (!Reg || Reg == ARM::ITSTATE || Reg == ARM::SP)
+      continue;
+    if (MO.isUse())
+      LocalUses.push_back(Reg);
+    else
+      LocalDefs.push_back(Reg);
+  }
+
+  for (unsigned i = 0, e = LocalUses.size(); i != e; ++i) {
+    unsigned Reg = LocalUses[i];
+    Uses.insert(Reg);
+    for (const unsigned *Subreg = TRI->getSubRegisters(Reg);
+         *Subreg; ++Subreg)
+      Uses.insert(*Subreg);
+  }
+
+  for (unsigned i = 0, e = LocalDefs.size(); i != e; ++i) {
+    unsigned Reg = LocalDefs[i];
+    Defs.insert(Reg);
+    for (const unsigned *Subreg = TRI->getSubRegisters(Reg);
+         *Subreg; ++Subreg)
+      Defs.insert(*Subreg);
+    if (Reg == ARM::CPSR)
+      continue;
+  }
+}
+
+bool
+Thumb2ITBlockPass::MoveCopyOutOfITBlock(MachineInstr *MI,
+                                      ARMCC::CondCodes CC, ARMCC::CondCodes OCC,
+                                        SmallSet<unsigned, 4> &Defs,
+                                        SmallSet<unsigned, 4> &Uses) {
+  unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
+  if (TII->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx)) {
+    assert(SrcSubIdx == 0 && DstSubIdx == 0 &&
+           "Sub-register indices still around?");
+    // llvm models select's as two-address instructions. That means a copy
+    // is inserted before a t2MOVccr, etc. If the copy is scheduled in
+    // between selects we would end up creating multiple IT blocks.
+
+    // First check if it's safe to move it.
+    if (Uses.count(DstReg) || Defs.count(SrcReg))
+      return false;
+
+    // Then peek at the next instruction to see if it's predicated on CC or OCC.
+    // If not, then there is nothing to be gained by moving the copy.
+    MachineBasicBlock::iterator I = MI; ++I;
+    MachineBasicBlock::iterator E = MI->getParent()->end();
+    while (I != E && I->isDebugValue())
+      ++I;
+    if (I != E) {
+      unsigned NPredReg = 0;
+      ARMCC::CondCodes NCC = llvm::getITInstrPredicate(I, NPredReg);
+      if (NCC == CC || NCC == OCC)
+        return true;
+    }
+  }
+  return false;
+}
+
+bool Thumb2ITBlockPass::InsertITInstructions(MachineBasicBlock &MBB) {
   bool Modified = false;
 
+  SmallSet<unsigned, 4> Defs;
+  SmallSet<unsigned, 4> Uses;
   MachineBasicBlock::iterator MBBI = MBB.begin(), E = MBB.end();
   while (MBBI != E) {
     MachineInstr *MI = &*MBBI;
     DebugLoc dl = MI->getDebugLoc();
     unsigned PredReg = 0;
-    ARMCC::CondCodes CC = getPredicate(MI, PredReg);
-
+    ARMCC::CondCodes CC = llvm::getITInstrPredicate(MI, PredReg);
     if (CC == ARMCC::AL) {
       ++MBBI;
       continue;
     }
 
+    Defs.clear();
+    Uses.clear();
+    TrackDefUses(MI, Defs, Uses, TRI);
+
     // Insert an IT instruction.
     MachineInstrBuilder MIB = BuildMI(MBB, MBBI, dl, TII->get(ARM::t2IT))
       .addImm(CC);
+
+    // Add implicit use of ITSTATE to IT block instructions.
+    MI->addOperand(MachineOperand::CreateReg(ARM::ITSTATE, false/*ifDef*/,
+                                             true/*isImp*/, false/*isKill*/));
+
+    MachineInstr *LastITMI = MI;
+    MachineBasicBlock::iterator InsertPos = MIB;
     ++MBBI;
 
-    // Finalize IT mask.
+    // Form IT block.
     ARMCC::CondCodes OCC = ARMCC::getOppositeCondition(CC);
     unsigned Mask = 0, Pos = 3;
     // Branches, including tricky ones like LDM_RET, need to end an IT
     // block so check the instruction we just put in the block.
-    while (MBBI != E && Pos &&
-           (!MI->getDesc().isBranch() && !MI->getDesc().isReturn())) {
+    for (; MBBI != E && Pos &&
+           (!MI->getDesc().isBranch() && !MI->getDesc().isReturn()) ; ++MBBI) {
+      if (MBBI->isDebugValue())
+        continue;
+
       MachineInstr *NMI = &*MBBI;
       MI = NMI;
-      DebugLoc ndl = NMI->getDebugLoc();
+
       unsigned NPredReg = 0;
-      ARMCC::CondCodes NCC = getPredicate(NMI, NPredReg);
-      if (NCC == CC || NCC == OCC)
+      ARMCC::CondCodes NCC = llvm::getITInstrPredicate(NMI, NPredReg);
+      if (NCC == CC || NCC == OCC) {
         Mask |= (NCC & 1) << Pos;
-      else
+        // Add implicit use of ITSTATE.
+        NMI->addOperand(MachineOperand::CreateReg(ARM::ITSTATE, false/*ifDef*/,
+                                               true/*isImp*/, false/*isKill*/));
+        LastITMI = NMI;
+      } else {
+        if (NCC == ARMCC::AL &&
+            MoveCopyOutOfITBlock(NMI, CC, OCC, Defs, Uses)) {
+          --MBBI;
+          MBB.remove(NMI);
+          MBB.insert(InsertPos, NMI);
+          ++NumMovedInsts;
+          continue;
+        }
         break;
+      }
+      TrackDefUses(NMI, Defs, Uses, TRI);
       --Pos;
-      ++MBBI;
     }
+
+    // Finalize IT mask.
     Mask |= (1 << Pos);
     // Tag along (firstcond[0] << 4) with the mask.
     Mask |= (CC & 1) << 4;
     MIB.addImm(Mask);
+
+    // Last instruction in IT block kills ITSTATE.
+    LastITMI->findRegisterUseOperand(ARM::ITSTATE)->setIsKill();
+
     Modified = true;
     ++NumITs;
   }
@@ -100,22 +408,29 @@ bool Thumb2ITBlockPass::runOnMachineFunction(MachineFunction &Fn) {
   const TargetMachine &TM = Fn.getTarget();
   AFI = Fn.getInfo<ARMFunctionInfo>();
   TII = static_cast<const Thumb2InstrInfo*>(TM.getInstrInfo());
+  TRI = TM.getRegisterInfo();
 
   if (!AFI->isThumbFunction())
     return false;
 
   bool Modified = false;
-  for (MachineFunction::iterator MFI = Fn.begin(), E = Fn.end(); MFI != E;
-       ++MFI) {
+  for (MachineFunction::iterator MFI = Fn.begin(), E = Fn.end(); MFI != E; ) {
     MachineBasicBlock &MBB = *MFI;
-    Modified |= InsertITBlocks(MBB);
+    ++MFI;
+    if (PreRegAlloc)
+      Modified |= InsertITBlocks(MBB);
+    else
+      Modified |= InsertITInstructions(MBB);
   }
 
+  if (Modified && !PreRegAlloc)
+    AFI->setHasITBlocks(true);
+
   return Modified;
 }
 
 /// createThumb2ITBlockPass - Returns an instance of the Thumb2 IT blocks
 /// insertion pass.
-FunctionPass *llvm::createThumb2ITBlockPass() {
-  return new Thumb2ITBlockPass();
+FunctionPass *llvm::createThumb2ITBlockPass(bool PreAlloc) {
+  return new Thumb2ITBlockPass(PreAlloc);
 }