Refine stack slot interval weight computation.
[oota-llvm.git] / lib / CodeGen / MachineLICM.cpp
index c66e0620bc73eb55f717c95dd2acd4d7dc70346f..7f48ab5499f798bf97c50d05cfcab95a82e6cb18 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Bill Wendling and is distributed under the
-// University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 //===----------------------------------------------------------------------===//
 
 #define DEBUG_TYPE "machine-licm"
-#include "llvm/ADT/IndexedMap.h"
-#include "llvm/ADT/SmallVector.h"
-#include "llvm/ADT/Statistic.h"
-#include "llvm/CodeGen/MachineBasicBlock.h"
+#include "llvm/CodeGen/Passes.h"
 #include "llvm/CodeGen/MachineDominators.h"
-#include "llvm/CodeGen/MachineInstr.h"
 #include "llvm/CodeGen/MachineLoopInfo.h"
-#include "llvm/CodeGen/Passes.h"
+#include "llvm/CodeGen/MachineRegisterInfo.h"
+#include "llvm/Target/TargetRegisterInfo.h"
 #include "llvm/Target/TargetInstrInfo.h"
-#include "llvm/Support/CFG.h"
+#include "llvm/Target/TargetMachine.h"
+#include "llvm/ADT/SmallVector.h"
+#include "llvm/ADT/Statistic.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/Compiler.h"
 #include "llvm/Support/Debug.h"
-#include "llvm/Target/MRegisterInfo.h"
-#include "llvm/Target/TargetMachine.h"
 
 using namespace llvm;
 
-namespace {
-  // Hidden options to help debugging
-  cl::opt<bool>
-  PerformLICM("machine-licm",
-              cl::init(false), cl::Hidden,
-              cl::desc("Perform loop-invariant code motion on machine code"));
-}
-
 STATISTIC(NumHoisted, "Number of machine instructions hoisted out of loops");
 
 namespace {
   class VISIBILITY_HIDDEN MachineLICM : public MachineFunctionPass {
-    // Various analyses that we use...
-    MachineLoopInfo      *LI;   // Current MachineLoopInfo
-    MachineDominatorTree *DT;   // Machine dominator tree for the current Loop
-
+    const TargetMachine   *TM;
     const TargetInstrInfo *TII;
+    MachineFunction       *CurMF;  // Current MachineFunction
 
-    // State that is updated as we process loops
-    bool         Changed;       // True if a loop is changed.
-    MachineLoop *CurLoop;       // The current loop we are working on.
+    // Various analyses that we use...
+    MachineLoopInfo      *LI;      // Current MachineLoopInfo
+    MachineDominatorTree *DT;      // Machine dominator tree for the cur loop
+    MachineRegisterInfo  *RegInfo; // Machine register information
 
-    // Map the def of a virtual register to the machine instruction.
-    IndexedMap<const MachineInstr*, VirtReg2IndexFunctor> VRegDefs;
+    // State that is updated as we process loops
+    bool         Changed;          // True if a loop is changed.
+    MachineLoop *CurLoop;          // The current loop we are working on.
   public:
     static char ID; // Pass identification, replacement for typeid
     MachineLICM() : MachineFunctionPass((intptr_t)&ID) {}
 
     virtual bool runOnMachineFunction(MachineFunction &MF);
 
-    /// FIXME: Loop preheaders?
-    ///
+    // FIXME: Loop preheaders?
     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
       AU.setPreservesCFG();
       AU.addRequired<MachineLoopInfo>();
       AU.addRequired<MachineDominatorTree>();
+      AU.addPreserved<MachineLoopInfo>();
+      AU.addPreserved<MachineDominatorTree>();
+      MachineFunctionPass::getAnalysisUsage(AU);
     }
   private:
     /// VisitAllLoops - Visit all of the loops in depth first order and try to
@@ -88,48 +79,13 @@ namespace {
       HoistRegion(DT->getNode(L->getHeader()));
     }
 
-    /// MapVirtualRegisterDefs - Create a map of which machine instruction
-    /// defines a virtual register.
-    /// 
-    void MapVirtualRegisterDefs(const MachineFunction &MF);
-
     /// IsInSubLoop - A little predicate that returns true if the specified
     /// basic block is in a subloop of the current one, not the current one
     /// itself.
     ///
     bool IsInSubLoop(MachineBasicBlock *BB) {
       assert(CurLoop->contains(BB) && "Only valid if BB is IN the loop");
-
-      for (MachineLoop::iterator
-             I = CurLoop->begin(), E = CurLoop->end(); I != E; ++I)
-        if ((*I)->contains(BB))
-          return true;  // A subloop actually contains this block!
-
-      return false;
-    }
-
-    /// CanHoistInst - Checks that this instructions is one that can be hoisted
-    /// out of the loop. I.e., it has no side effects, isn't a control flow
-    /// instr, etc.
-    ///
-    bool CanHoistInst(MachineInstr &I) const {
-      const TargetInstrDescriptor *TID = I.getInstrDescriptor();
-
-      // Don't hoist if this instruction implicitly reads physical registers or
-      // doesn't take any operands.
-      if (TID->ImplicitUses || !I.getNumOperands()) return false;
-
-      MachineOpCode Opcode = TID->Opcode;
-      return TII->isTriviallyReMaterializable(&I) &&
-        // FIXME: Below necessary?
-        !(TII->isReturn(Opcode) ||
-          TII->isTerminatorInstr(Opcode) ||
-          TII->isBranch(Opcode) ||
-          TII->isIndirectBranch(Opcode) ||
-          TII->isBarrier(Opcode) ||
-          TII->isCall(Opcode) ||
-          TII->isLoad(Opcode) || // TODO: Do loads and stores.
-          TII->isStore(Opcode));
+      return LI->getLoopFor(BB) != CurLoop;
     }
 
     /// IsLoopInvariantInst - Returns true if the instruction is loop
@@ -142,7 +98,7 @@ namespace {
     /// FindPredecessors - Get all of the predecessors of the loop that are not
     /// back-edges.
     /// 
-    void FindPredecessors(std::vector<MachineBasicBlock*> &Preds){
+    void FindPredecessors(std::vector<MachineBasicBlock*> &Preds) {
       const MachineBasicBlock *Header = CurLoop->getHeader();
 
       for (MachineBasicBlock::const_pred_iterator
@@ -154,9 +110,30 @@ namespace {
     /// MoveInstToEndOfBlock - Moves the machine instruction to the bottom of
     /// the predecessor basic block (but before the terminator instructions).
     /// 
-    void MoveInstToEndOfBlock(MachineBasicBlock *MBB, MachineInstr *MI) {
-      MachineBasicBlock::iterator Iter = MBB->getFirstTerminator();
-      MBB->insert(Iter, MI);
+    void MoveInstToEndOfBlock(MachineBasicBlock *ToMBB,
+                              MachineBasicBlock *FromMBB,
+                              MachineInstr *MI) {
+      DEBUG({
+          DOUT << "Hoisting " << *MI;
+          if (ToMBB->getBasicBlock())
+            DOUT << " to MachineBasicBlock "
+                 << ToMBB->getBasicBlock()->getName();
+          if (FromMBB->getBasicBlock())
+            DOUT << " from MachineBasicBlock "
+                 << FromMBB->getBasicBlock()->getName();
+          DOUT << "\n";
+        });
+
+      MachineBasicBlock::iterator WhereIter = ToMBB->getFirstTerminator();
+      MachineBasicBlock::iterator To, From = FromMBB->begin();
+
+      while (&*From != MI)
+        ++From;
+
+      assert(From != FromMBB->end() && "Didn't find instr in BB!");
+
+      To = From;
+      ToMBB->splice(WhereIter, FromMBB, From, ++To);
       ++NumHoisted;
     }
 
@@ -173,12 +150,12 @@ namespace {
     ///
     void Hoist(MachineInstr &MI);
   };
-
-  char MachineLICM::ID = 0;
-  RegisterPass<MachineLICM> X("machine-licm",
-                              "Machine Loop Invariant Code Motion");
 } // end anonymous namespace
 
+char MachineLICM::ID = 0;
+static RegisterPass<MachineLICM>
+X("machine-licm", "Machine Loop Invariant Code Motion");
+
 FunctionPass *llvm::createMachineLICMPass() { return new MachineLICM(); }
 
 /// Hoist expressions out of the specified loop. Note, alias info for inner loop
@@ -186,10 +163,13 @@ FunctionPass *llvm::createMachineLICMPass() { return new MachineLICM(); }
 /// loop.
 ///
 bool MachineLICM::runOnMachineFunction(MachineFunction &MF) {
-  if (!PerformLICM) return false; // For debugging.
+  DOUT << "******** Machine LICM ********\n";
 
   Changed = false;
-  TII = MF.getTarget().getInstrInfo();
+  CurMF = &MF;
+  TM = &CurMF->getTarget();
+  TII = TM->getInstrInfo();
+  RegInfo = &CurMF->getRegInfo();
 
   // Get our Loop information...
   LI = &getAnalysis<MachineLoopInfo>();
@@ -197,41 +177,17 @@ bool MachineLICM::runOnMachineFunction(MachineFunction &MF) {
 
   for (MachineLoopInfo::iterator
          I = LI->begin(), E = LI->end(); I != E; ++I) {
-    MachineLoop *L = *I;
-    CurLoop = L;
+    CurLoop = *I;
 
     // Visit all of the instructions of the loop. We want to visit the subloops
     // first, though, so that we can hoist their invariants first into their
     // containing loop before we process that loop.
-    VisitAllLoops(L);
+    VisitAllLoops(CurLoop);
   }
 
   return Changed;
 }
 
-/// MapVirtualRegisterDefs - Create a map of which machine instruction defines a
-/// virtual register.
-/// 
-void MachineLICM::MapVirtualRegisterDefs(const MachineFunction &MF) {
-  for (MachineFunction::const_iterator
-         I = MF.begin(), E = MF.end(); I != E; ++I) {
-    const MachineBasicBlock &MBB = *I;
-
-    for (MachineBasicBlock::const_iterator
-           II = MBB.begin(), IE = MBB.end(); II != IE; ++II) {
-      const MachineInstr &MI = *II;
-
-      for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
-        const MachineOperand &MO = MI.getOperand(0);
-
-        if (MO.isRegister() && MO.isDef() &&
-            MRegisterInfo::isVirtualRegister(MO.getReg()))
-          VRegDefs[MO.getReg()] = &MI;
-      }
-    }
-  }
-}
-
 /// HoistRegion - Walk the specified region of the CFG (defined by all blocks
 /// dominated by the specified block, and that are in the current loop) in depth
 /// first order w.r.t the DominatorTree. This allows us to visit definitions
@@ -265,13 +221,50 @@ void MachineLICM::HoistRegion(MachineDomTreeNode *N) {
 
 /// IsLoopInvariantInst - Returns true if the instruction is loop
 /// invariant. I.e., all virtual register operands are defined outside of the
-/// loop, physical registers aren't accessed (explicitly or implicitly), and the
-/// instruction is hoistable.
+/// loop, physical registers aren't accessed explicitly, and there are no side
+/// effects that aren't captured by the operands or other flags.
 /// 
 bool MachineLICM::IsLoopInvariantInst(MachineInstr &I) {
-  if (!CanHoistInst(I)) return false;
+  const TargetInstrDesc &TID = I.getDesc();
+  
+  // Ignore stuff that we obviously can't hoist.
+  if (TID.mayStore() || TID.isCall() || TID.isReturn() || TID.isBranch() ||
+      TID.hasUnmodeledSideEffects())
+    return false;
+  
+  if (TID.mayLoad()) {
+    // Okay, this instruction does a load. As a refinement, we allow the target
+    // to decide whether the loaded value is actually a constant. If so, we can
+    // actually use it as a load.
+    if (!TII->isInvariantLoad(&I))
+      // FIXME: we should be able to sink loads with no other side effects if
+      // there is nothing that can change memory from here until the end of
+      // block. This is a trivial form of alias analysis.
+      return false;
+  }
+
+  DEBUG({
+      DOUT << "--- Checking if we can hoist " << I;
+      if (I.getDesc().getImplicitUses()) {
+        DOUT << "  * Instruction has implicit uses:\n";
 
-  // The instruction is loop invariant if all of its operands are loop-invariant
+        const TargetRegisterInfo *TRI = TM->getRegisterInfo();
+        for (const unsigned *ImpUses = I.getDesc().getImplicitUses();
+             *ImpUses; ++ImpUses)
+          DOUT << "      -> " << TRI->getName(*ImpUses) << "\n";
+      }
+
+      if (I.getDesc().getImplicitDefs()) {
+        DOUT << "  * Instruction has implicit defines:\n";
+
+        const TargetRegisterInfo *TRI = TM->getRegisterInfo();
+        for (const unsigned *ImpDefs = I.getDesc().getImplicitDefs();
+             *ImpDefs; ++ImpDefs)
+          DOUT << "      -> " << TRI->getName(*ImpDefs) << "\n";
+      }
+    });
+
+  // The instruction is loop invariant if all of its operands are.
   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
     const MachineOperand &MO = I.getOperand(i);
 
@@ -279,16 +272,18 @@ bool MachineLICM::IsLoopInvariantInst(MachineInstr &I) {
       continue;
 
     unsigned Reg = MO.getReg();
+    if (Reg == 0) continue;
 
     // Don't hoist instructions that access physical registers.
-    if (!MRegisterInfo::isVirtualRegister(Reg))
+    if (TargetRegisterInfo::isPhysicalRegister(Reg))
       return false;
 
-    assert(VRegDefs[Reg] && "Machine instr not mapped for this vreg?");
+    assert(RegInfo->getVRegDef(Reg) &&
+           "Machine instr not mapped for this vreg?!");
 
     // If the loop contains the definition of an operand, then the instruction
     // isn't loop invariant.
-    if (CurLoop->contains(VRegDefs[Reg]->getParent()))
+    if (CurLoop->contains(RegInfo->getVRegDef(Reg)->getParent()))
       return false;
   }
 
@@ -296,8 +291,8 @@ bool MachineLICM::IsLoopInvariantInst(MachineInstr &I) {
   return true;
 }
 
-/// Hoist - When an instruction is found to only use loop invariant operands
-/// that is safe to hoist, this instruction is called to do the dirty work.
+/// Hoist - When an instruction is found to use only loop invariant operands
+/// that are safe to hoist, this instruction is called to do the dirty work.
 ///
 void MachineLICM::Hoist(MachineInstr &MI) {
   if (!IsLoopInvariantInst(MI)) return;
@@ -324,9 +319,6 @@ void MachineLICM::Hoist(MachineInstr &MI) {
          "The predecessor doesn't feed directly into the loop header!");
 
   // Now move the instructions to the predecessor.
-  MoveInstToEndOfBlock(MBB, MI.clone());
-
-  // Hoisting was successful! Remove bothersome instruction now.
-  MI.getParent()->remove(&MI);
+  MoveInstToEndOfBlock(MBB, MI.getParent(), &MI);
   Changed = true;
 }