Hoist the contents of Loops in depth first order in the dominator tree,
[oota-llvm.git] / lib / Transforms / LevelRaise.cpp
index 8703b928b4cf711a9644d069d9427a32dd35b74d..a1ca7eb22daa01ba986b0246a1f0d4f3f1f7b228 100644 (file)
@@ -6,7 +6,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/Transforms/LevelChange.h"
+#include "llvm/Transforms/RaisePointerReferences.h"
 #include "llvm/Transforms/Utils/Local.h"
 #include "TransformInternals.h"
 #include "llvm/iOther.h"
 #include "llvm/Pass.h"
 #include "llvm/ConstantHandling.h"
 #include "llvm/Analysis/Expressions.h"
+#include "llvm/Analysis/Verifier.h"
 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
 #include "Support/STLExtras.h"
 #include "Support/StatisticReporter.h"
+#include "Support/CommandLine.h"
 #include <algorithm>
+using std::cerr;
 
-static Statistic<> NumLoadStorePeepholes("raise\t\t- Number of load/store peepholes");
-static Statistic<> NumGEPInstFormed("raise\t\t- Number of other getelementptr's formed");
-static Statistic<> NumExprTreesConv("raise\t\t- Number of expression trees converted");
-static Statistic<> NumCastOfCast("raise\t\t- Number of cast-of-self removed");
-static Statistic<> NumDCEorCP("raise\t\t- Number of insts DCE'd or constprop'd");
+// StartInst - This enables the -raise-start-inst=foo option to cause the level
+// raising pass to start at instruction "foo", which is immensely useful for
+// debugging!
+//
+static cl::opt<std::string>
+StartInst("raise-start-inst", cl::Hidden, cl::value_desc("inst name"),
+       cl::desc("Start raise pass at the instruction with the specified name"));
+
+static Statistic<>
+NumLoadStorePeepholes("raise\t\t- Number of load/store peepholes");
+
+static Statistic<> 
+NumGEPInstFormed("raise\t\t- Number of other getelementptr's formed");
+
+static Statistic<>
+NumExprTreesConv("raise\t\t- Number of expression trees converted");
+
+static Statistic<>
+NumCastOfCast("raise\t\t- Number of cast-of-self removed");
+
+static Statistic<>
+NumDCEorCP("raise\t\t- Number of insts DCEd or constprop'd");
 
 
 #define PRINT_PEEPHOLE(ID, NUM, I)            \
@@ -58,16 +78,18 @@ static inline bool isReinterpretingCast(const CastInst *CI) {
 //
 static bool HandleCastToPointer(BasicBlock::iterator BI,
                                 const PointerType *DestPTy) {
-  CastInst *CI = cast<CastInst>(*BI);
-  if (CI->use_empty()) return false;
+  CastInst &CI = cast<CastInst>(*BI);
+  if (CI.use_empty()) return false;
 
   // Scan all of the uses, looking for any uses that are not add
   // instructions.  If we have non-adds, do not make this transformation.
   //
-  for (Value::use_iterator I = CI->use_begin(), E = CI->use_end();
+  for (Value::use_iterator I = CI.use_begin(), E = CI.use_end();
        I != E; ++I) {
     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(*I)) {
-      if (BO->getOpcode() != Instruction::Add)
+      if (BO->getOpcode() != Instruction::Add ||
+          // Avoid add sbyte* %X, %X cases...
+          BO->getOperand(0) == BO->getOperand(1))
         return false;
     } else {
       return false;
@@ -75,7 +97,7 @@ static bool HandleCastToPointer(BasicBlock::iterator BI,
   }
 
   std::vector<Value*> Indices;
-  Value *Src = CI->getOperand(0);
+  Value *Src = CI.getOperand(0);
   const Type *Result = ConvertableToGEP(DestPTy, Src, Indices, &BI);
   if (Result == 0) return false;  // Not convertable...
 
@@ -83,13 +105,13 @@ static bool HandleCastToPointer(BasicBlock::iterator BI,
 
   // If we have a getelementptr capability... transform all of the 
   // add instruction uses into getelementptr's.
-  while (!CI->use_empty()) {
-    BinaryOperator *I = cast<BinaryOperator>(*CI->use_begin());
+  while (!CI.use_empty()) {
+    BinaryOperator *I = cast<BinaryOperator>(*CI.use_begin());
     assert(I->getOpcode() == Instruction::Add && I->getNumOperands() == 2 &&
            "Use is not a valid add instruction!");
     
     // Get the value added to the cast result pointer...
-    Value *OtherPtr = I->getOperand((I->getOperand(0) == CI) ? 1 : 0);
+    Value *OtherPtr = I->getOperand((I->getOperand(0) == &CI) ? 1 : 0);
 
     Instruction *GEP = new GetElementPtrInst(OtherPtr, Indices, I->getName());
     PRINT_PEEPHOLE1("cast-add-to-gep:i", I);
@@ -102,16 +124,14 @@ static bool HandleCastToPointer(BasicBlock::iterator BI,
       // add instruction type, insert a cast now.
       //
 
-      // Insert the GEP instruction before the old add instruction... and get an
-      // iterator to point at the add instruction...
-      BasicBlock::iterator GEPI = InsertInstBeforeInst(GEP, I)+1;
+      // Insert the GEP instruction before the old add instruction...
+      I->getParent()->getInstList().insert(I, GEP);
 
       PRINT_PEEPHOLE1("cast-add-to-gep:o", GEP);
-      CastInst *CI = new CastInst(GEP, I->getType());
-      GEP = CI;
+      GEP = new CastInst(GEP, I->getType());
 
       // Replace the old add instruction with the shiny new GEP inst
-      ReplaceInstWithInst(I->getParent()->getInstList(), GEPI, GEP);
+      ReplaceInstWithInst(I, GEP);
     }
 
     PRINT_PEEPHOLE1("cast-add-to-gep:o", GEP);
@@ -145,7 +165,7 @@ static bool PeepholeOptimizeAddCast(BasicBlock *BB, BasicBlock::iterator &BI,
   }
 
   // Only proceed if we have detected all of our conditions successfully...
-  if (!CompTy || !SrcPtr || !OffsetVal->getType()->isIntegral())
+  if (!CompTy || !SrcPtr || !OffsetVal->getType()->isInteger())
     return false;
 
   std::vector<Value*> Indices;
@@ -159,8 +179,7 @@ static bool PeepholeOptimizeAddCast(BasicBlock *BB, BasicBlock::iterator &BI,
   }
 
   GetElementPtrInst *GEP = new GetElementPtrInst(SrcPtr, Indices,
-                                                 AddOp2->getName());
-  BI = BB->getInstList().insert(BI, GEP)+1;
+                                                 AddOp2->getName(), BI);
 
   Instruction *NCI = new CastInst(GEP, AddOp1->getType());
   ReplaceInstWithInst(BB->getInstList(), BI, NCI);
@@ -169,7 +188,7 @@ static bool PeepholeOptimizeAddCast(BasicBlock *BB, BasicBlock::iterator &BI,
 }
 
 static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
-  Instruction *I = *BI;
+  Instruction *I = BI;
 
   if (CastInst *CI = dyn_cast<CastInst>(I)) {
     Value       *Src    = CI->getOperand(0);
@@ -193,7 +212,7 @@ static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
       // DCE the instruction now, to avoid having the iterative version of DCE
       // have to worry about it.
       //
-      delete BB->getInstList().remove(BI);
+      BI = BB->getInstList().erase(BI);
 
       ++NumCastOfCast;
       return true;
@@ -212,14 +231,20 @@ static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
         PRINT_PEEPHOLE3("CAST-SRC-EXPR-CONV:in ", Src, CI, BB->getParent());
           
         DEBUG(cerr << "\nCONVERTING SRC EXPR TYPE:\n");
-        ValueMapCache ValueMap;
-        Value *E = ConvertExpressionToType(Src, DestTy, ValueMap);
-        if (Constant *CPV = dyn_cast<Constant>(E))
-          CI->replaceAllUsesWith(CPV);
+        { // ValueMap must be destroyed before function verified!
+          ValueMapCache ValueMap;
+          Value *E = ConvertExpressionToType(Src, DestTy, ValueMap);
 
+          if (Constant *CPV = dyn_cast<Constant>(E))
+            CI->replaceAllUsesWith(CPV);
+          
+          PRINT_PEEPHOLE1("CAST-SRC-EXPR-CONV:out", E);
+          DEBUG(cerr << "DONE CONVERTING SRC EXPR TYPE: \n" << BB->getParent());
+        }
+
+        DEBUG(assert(verifyFunction(*BB->getParent()) == false &&
+                     "Function broken!"));
         BI = BB->begin();  // Rescan basic block.  BI might be invalidated.
-        PRINT_PEEPHOLE1("CAST-SRC-EXPR-CONV:out", E);
-        DEBUG(cerr << "DONE CONVERTING SRC EXPR TYPE: \n" << BB->getParent());
         ++NumExprTreesConv;
         return true;
       }
@@ -228,16 +253,22 @@ static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
       // source type of the cast...
       //
       ConvertedTypes.clear();
+      ConvertedTypes[Src] = Src->getType();  // Make sure the source doesn't change type
       if (ValueConvertableToType(CI, Src->getType(), ConvertedTypes)) {
         PRINT_PEEPHOLE3("CAST-DEST-EXPR-CONV:in ", Src, CI, BB->getParent());
 
         DEBUG(cerr << "\nCONVERTING EXPR TYPE:\n");
-        ValueMapCache ValueMap;
-        ConvertValueToNewType(CI, Src, ValueMap);  // This will delete CI!
+        { // ValueMap must be destroyed before function verified!
+          ValueMapCache ValueMap;
+          ConvertValueToNewType(CI, Src, ValueMap);  // This will delete CI!
+        }
 
-        BI = BB->begin();  // Rescan basic block.  BI might be invalidated.
         PRINT_PEEPHOLE1("CAST-DEST-EXPR-CONV:out", Src);
         DEBUG(cerr << "DONE CONVERTING EXPR TYPE: \n\n" << BB->getParent());
+
+        DEBUG(assert(verifyFunction(*BB->getParent()) == false &&
+                     "Function broken!"));
+        BI = BB->begin();  // Rescan basic block.  BI might be invalidated.
         ++NumExprTreesConv;
         return true;
       }
@@ -292,7 +323,7 @@ static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
 
           // Build the index vector, full of all zeros
           std::vector<Value*> Indices;
-          Indices.push_back(ConstantUInt::get(Type::UIntTy, 0));
+          Indices.push_back(ConstantSInt::get(Type::LongTy, 0));
           while (CurCTy && !isa<PointerType>(CurCTy)) {
             if (const StructType *CurSTy = dyn_cast<StructType>(CurCTy)) {
               // Check for a zero element struct type... if we have one, bail.
@@ -307,7 +338,7 @@ static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
             }
 
             // Insert a zero to index through this type...
-            Indices.push_back(ConstantUInt::get(CurCTy->getIndexType(), 0));
+            Indices.push_back(Constant::getNullValue(CurCTy->getIndexType()));
 
             // Did we find what we're looking for?
             if (ElTy->isLosslesslyConvertableTo(DestPointedTy)) break;
@@ -322,11 +353,11 @@ static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
           if (ElTy) {
             PRINT_PEEPHOLE1("cast-for-first:in", CI);
 
+            std::string Name = CI->getName(); CI->setName("");
+
             // Insert the new T cast instruction... stealing old T's name
             GetElementPtrInst *GEP = new GetElementPtrInst(Src, Indices,
-                                                           CI->getName());
-            CI->setName("");
-            BI = BB->getInstList().insert(BI, GEP)+1;
+                                                           Name, BI);
 
             // Make the old cast instruction reference the new GEP instead of
             // the old src value.
@@ -359,17 +390,15 @@ static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
     //
     if (CastInst *CI = dyn_cast<CastInst>(Pointer))
       if (Value *CastSrc = CI->getOperand(0)) // CSPT = CastSrcPointerType
-        if (PointerType *CSPT = dyn_cast<PointerType>(CastSrc->getType()))
+        if (const PointerType *CSPT = dyn_cast<PointerType>(CastSrc->getType()))
           // convertable types?
-          if (Val->getType()->isLosslesslyConvertableTo(CSPT->getElementType()) &&
-              !SI->hasIndices()) {      // No subscripts yet!
+          if (Val->getType()->isLosslesslyConvertableTo(CSPT->getElementType())) {
             PRINT_PEEPHOLE3("st-src-cast:in ", Pointer, Val, SI);
 
             // Insert the new T cast instruction... stealing old T's name
+            std::string Name(CI->getName()); CI->setName("");
             CastInst *NCI = new CastInst(Val, CSPT->getElementType(),
-                                         CI->getName());
-            CI->setName("");
-            BI = BB->getInstList().insert(BI, NCI)+1;
+                                         Name, BI);
 
             // Replace the old store with a new one!
             ReplaceInstWithInst(BB->getInstList(), BI,
@@ -399,18 +428,16 @@ static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
     //
     if (CastInst *CI = dyn_cast<CastInst>(Pointer))
       if (Value *CastSrc = CI->getOperand(0)) // CSPT = CastSrcPointerType
-        if (PointerType *CSPT = dyn_cast<PointerType>(CastSrc->getType()))
+        if (const PointerType *CSPT = dyn_cast<PointerType>(CastSrc->getType()))
           // convertable types?
-          if (PtrElType->isLosslesslyConvertableTo(CSPT->getElementType()) &&
-              !LI->hasIndices()) {      // No subscripts yet!
+          if (PtrElType->isLosslesslyConvertableTo(CSPT->getElementType())) {
             PRINT_PEEPHOLE2("load-src-cast:in ", Pointer, LI);
 
             // Create the new load instruction... loading the pre-casted value
-            LoadInst *NewLI = new LoadInst(CastSrc, LI->getName());
+            LoadInst *NewLI = new LoadInst(CastSrc, LI->getName(), BI);
             
             // Insert the new T cast instruction... stealing old T's name
             CastInst *NCI = new CastInst(NewLI, LI->getType(), CI->getName());
-            BI = BB->getInstList().insert(BI, NewLI)+1;
 
             // Replace the old store with a new one!
             ReplaceInstWithInst(BB->getInstList(), BI, NCI);
@@ -435,24 +462,22 @@ static bool PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
 
 
 
-static bool DoRaisePass(Function *F) {
+static bool DoRaisePass(Function &F) {
   bool Changed = false;
-  for (Function::iterator MI = F->begin(), ME = F->end(); MI != ME; ++MI) {
-    BasicBlock *BB = *MI;
-    BasicBlock::InstListType &BIL = BB->getInstList();
-
+  for (Function::iterator BB = F.begin(), BBE = F.end(); BB != BBE; ++BB)
     for (BasicBlock::iterator BI = BB->begin(); BI != BB->end();) {
       DEBUG(cerr << "Processing: " << *BI);
-      if (dceInstruction(BIL, BI) || doConstantPropogation(BB, BI)) {
+      if (dceInstruction(BI) || doConstantPropogation(BI)) {
         Changed = true; 
         ++NumDCEorCP;
-        DEBUG(cerr << "***\t\t^^-- DeadCode Elinated!\n");
-      } else if (PeepholeOptimize(BB, BI))
+        DEBUG(cerr << "***\t\t^^-- Dead code eliminated!\n");
+      } else if (PeepholeOptimize(BB, BI)) {
         Changed = true;
-      else
+      } else {
         ++BI;
+      }
     }
-  }
+
   return Changed;
 }
 
@@ -460,14 +485,29 @@ static bool DoRaisePass(Function *F) {
 // RaisePointerReferences::doit - Raise a function representation to a higher
 // level.
 //
-static bool doRPR(Function *F) {
-  DEBUG(cerr << "\n\n\nStarting to work on Function '" << F->getName()<< "'\n");
+static bool doRPR(Function &F) {
+  DEBUG(cerr << "\n\n\nStarting to work on Function '" << F.getName() << "'\n");
 
   // Insert casts for all incoming pointer pointer values that are treated as
   // arrays...
   //
   bool Changed = false, LocalChange;
   
+
+  // If the StartInst option was specified, then Peephole optimize that
+  // instruction first if it occurs in this function.
+  //
+  if (!StartInst.empty()) {
+    for (Function::iterator BB = F.begin(), BBE = F.end(); BB != BBE; ++BB)
+      for (BasicBlock::iterator BI = BB->begin(); BI != BB->end(); ++BI)
+        if (BI->getName() == StartInst) {
+          bool SavedDebug = DebugFlag;  // Save the DEBUG() controlling flag.
+          DebugFlag = true;             // Turn on DEBUG's
+          Changed |= PeepholeOptimize(BB, BI);
+          DebugFlag = SavedDebug;       // Restore DebugFlag to previous state
+        }
+  }
+
   do {
     DEBUG(cerr << "Looping: \n" << F);
 
@@ -484,9 +524,11 @@ static bool doRPR(Function *F) {
 
 namespace {
   struct RaisePointerReferences : public FunctionPass {
-    const char *getPassName() const { return "Raise Pointer References"; }
 
-    virtual bool runOnFunction(Function *F) { return doRPR(F); }
+    // FIXME: constructor should save and use target data here!!
+    RaisePointerReferences(const TargetData &TD) {}
+
+    virtual bool runOnFunction(Function &F) { return doRPR(F); }
 
     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
       AU.preservesCFG();
@@ -494,8 +536,9 @@ namespace {
   };
 }
 
-Pass *createRaisePointerReferencesPass() {
-  return new RaisePointerReferences();
+Pass *createRaisePointerReferencesPass(const TargetData &TD) {
+  return new RaisePointerReferences(TD);
 }
 
-
+static RegisterOpt<RaisePointerReferences>
+X("raise", "Raise Pointer References", createRaisePointerReferencesPass);