Changes For Bug 352
[oota-llvm.git] / lib / Transforms / LevelRaise.cpp
index 110c0cc505ce204e55fc0fde0022e341f3a02647..cc4e69d9acd4e24c043d68b58ef7284c7a22a413 100644 (file)
@@ -1,4 +1,11 @@
-//===- LevelRaise.cpp - Code to change LLVM to higher level -----------------=//
+//===- LevelRaise.cpp - Code to change LLVM to higher level ---------------===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This file implements the 'raising' part of the LevelChange API.  This is
 // useful because, in general, it makes the LLVM code terser and easier to
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/Transforms/RaisePointerReferences.h"
+#include "llvm/Transforms/Scalar.h"
 #include "llvm/Transforms/Utils/Local.h"
 #include "TransformInternals.h"
-#include "llvm/iOther.h"
-#include "llvm/iMemory.h"
+#include "llvm/Instructions.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/Statistic.h"
-#include "Support/CommandLine.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/Debug.h"
+#include "llvm/ADT/Statistic.h"
+#include "llvm/ADT/STLExtras.h"
 #include <algorithm>
-using std::cerr;
+using namespace llvm;
 
 // 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
@@ -48,7 +52,6 @@ NumDCEorCP("raise", "Number of insts DCEd or constprop'd");
 static Statistic<>
 NumVarargCallChanges("raise", "Number of vararg call peepholes");
 
-
 #define PRINT_PEEPHOLE(ID, NUM, I)            \
   DEBUG(std::cerr << "Inst P/H " << ID << "[" << NUM << "] " << I)
 
@@ -79,18 +82,18 @@ namespace {
   RegisterOpt<RPR> X("raise", "Raise Pointer References");
 }
 
-Pass *createRaisePointerReferencesPass() {
+
+Pass *llvm::createRaisePointerReferencesPass() {
   return new RPR();
 }
 
 
-
 // isReinterpretingCast - Return true if the cast instruction specified will
 // cause the operand to be "reinterpreted".  A value is reinterpreted if the
 // cast instruction would cause the underlying bits to change.
 //
 static inline bool isReinterpretingCast(const CastInst *CI) {
-  return!CI->getOperand(0)->getType()->isLosslesslyConvertableTo(CI->getType());
+  return!CI->getOperand(0)->getType()->isLosslesslyConvertibleTo(CI->getType());
 }
 
 
@@ -107,40 +110,56 @@ static bool HandleCastToPointer(BasicBlock::iterator BI,
   CastInst &CI = cast<CastInst>(*BI);
   if (CI.use_empty()) return false;
 
-  // Scan all of the uses, looking for any uses that are not add
+  // Scan all of the uses, looking for any uses that are not add or sub
   // instructions.  If we have non-adds, do not make this transformation.
   //
+  bool HasSubUse = false;  // Keep track of any subtracts...
   for (Value::use_iterator I = CI.use_begin(), E = CI.use_end();
-       I != E; ++I) {
+       I != E; ++I)
     if (BinaryOperator *BO = dyn_cast<BinaryOperator>(*I)) {
-      if (BO->getOpcode() != Instruction::Add ||
+      if ((BO->getOpcode() != Instruction::Add &&
+           BO->getOpcode() != Instruction::Sub) ||
           // Avoid add sbyte* %X, %X cases...
           BO->getOperand(0) == BO->getOperand(1))
         return false;
+      else
+        HasSubUse |= BO->getOpcode() == Instruction::Sub;
     } else {
       return false;
     }
-  }
 
   std::vector<Value*> Indices;
   Value *Src = CI.getOperand(0);
-  const Type *Result = ConvertableToGEP(DestPTy, Src, Indices, TD, &BI);
-  if (Result == 0) return false;  // Not convertable...
+  const Type *Result = ConvertibleToGEP(DestPTy, Src, Indices, TD, &BI);
+  if (Result == 0) return false;  // Not convertible...
 
-  PRINT_PEEPHOLE2("cast-add-to-gep:in", Src, CI);
+  // Cannot handle subtracts if there is more than one index required...
+  if (HasSubUse && Indices.size() != 1) return false;
+
+  PRINT_PEEPHOLE2("cast-add-to-gep:in", *Src, CI);
 
   // 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());
-    assert(I->getOpcode() == Instruction::Add && I->getNumOperands() == 2 &&
+    assert((I->getOpcode() == Instruction::Add ||
+            I->getOpcode() == Instruction::Sub) && 
            "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);
 
     Instruction *GEP = new GetElementPtrInst(OtherPtr, Indices, I->getName());
-    PRINT_PEEPHOLE1("cast-add-to-gep:i", I);
+    PRINT_PEEPHOLE1("cast-add-to-gep:i", *I);
+
+    // If the instruction is actually a subtract, we are guaranteed to only have
+    // one index (from code above), so we just need to negate the pointer index
+    // long value.
+    if (I->getOpcode() == Instruction::Sub) {
+      Instruction *Neg = BinaryOperator::createNeg(GEP->getOperand(1), 
+                                       GEP->getOperand(1)->getName()+".neg", I);
+      GEP->setOperand(1, Neg);
+    }
 
     if (GEP->getType() == I->getType()) {
       // Replace the old add instruction with the shiny new GEP inst
@@ -153,14 +172,14 @@ static bool HandleCastToPointer(BasicBlock::iterator BI,
       // Insert the GEP instruction before the old add instruction...
       I->getParent()->getInstList().insert(I, GEP);
 
-      PRINT_PEEPHOLE1("cast-add-to-gep:o", GEP);
+      PRINT_PEEPHOLE1("cast-add-to-gep:o", *GEP);
       GEP = new CastInst(GEP, I->getType());
 
       // Replace the old add instruction with the shiny new GEP inst
       ReplaceInstWithInst(I, GEP);
     }
 
-    PRINT_PEEPHOLE1("cast-add-to-gep:o", GEP);
+    PRINT_PEEPHOLE1("cast-add-to-gep:o", *GEP);
   }
   return true;
 }
@@ -196,13 +215,13 @@ static bool PeepholeOptimizeAddCast(BasicBlock *BB, BasicBlock::iterator &BI,
     return false;
 
   std::vector<Value*> Indices;
-  if (!ConvertableToGEP(SrcPtr->getType(), OffsetVal, Indices, TD, &BI))
-    return false;  // Not convertable... perhaps next time
+  if (!ConvertibleToGEP(SrcPtr->getType(), OffsetVal, Indices, TD, &BI))
+    return false;  // Not convertible... perhaps next time
 
   if (getPointedToComposite(AddOp1->getType())) {  // case 1
-    PRINT_PEEPHOLE2("add-to-gep1:in", AddOp2, *BI);
+    PRINT_PEEPHOLE2("add-to-gep1:in", *AddOp2, *BI);
   } else {
-    PRINT_PEEPHOLE3("add-to-gep2:in", AddOp1, AddOp2, *BI);
+    PRINT_PEEPHOLE3("add-to-gep2:in", *AddOp1, *AddOp2, *BI);
   }
 
   GetElementPtrInst *GEP = new GetElementPtrInst(SrcPtr, Indices,
@@ -210,7 +229,7 @@ static bool PeepholeOptimizeAddCast(BasicBlock *BB, BasicBlock::iterator &BI,
 
   Instruction *NCI = new CastInst(GEP, AddOp1->getType());
   ReplaceInstWithInst(BB->getInstList(), BI, NCI);
-  PRINT_PEEPHOLE2("add-to-gep:out", GEP, NCI);
+  PRINT_PEEPHOLE2("add-to-gep:out", *GEP, *NCI);
   return true;
 }
 
@@ -229,7 +248,7 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
     // Into: <nothing>
     //
     if (DestTy == Src->getType()) {   // Check for a cast to same type as src!!
-      PRINT_PEEPHOLE1("cast-of-self-ty", CI);
+      PRINT_PEEPHOLE1("cast-of-self-ty", *CI);
       CI->replaceAllUsesWith(Src);
       if (!Src->hasName() && CI->hasName()) {
         std::string Name = CI->getName();
@@ -255,10 +274,10 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
       // destination type of the cast...
       //
       ConvertedTypes[CI] = CI->getType();  // Make sure the cast doesn't change
-      if (ExpressionConvertableToType(Src, DestTy, ConvertedTypes, TD)) {
-        PRINT_PEEPHOLE3("CAST-SRC-EXPR-CONV:in ", Src, CI, BB->getParent());
+      if (ExpressionConvertibleToType(Src, DestTy, ConvertedTypes, TD)) {
+        PRINT_PEEPHOLE3("CAST-SRC-EXPR-CONV:in ", *Src, *CI, *BB->getParent());
           
-        DEBUG(cerr << "\nCONVERTING SRC EXPR TYPE:\n");
+        DEBUG(std::cerr << "\nCONVERTING SRC EXPR TYPE:\n");
         { // ValueMap must be destroyed before function verified!
           ValueMapCache ValueMap;
           Value *E = ConvertExpressionToType(Src, DestTy, ValueMap, TD);
@@ -266,12 +285,11 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
           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());
+          PRINT_PEEPHOLE1("CAST-SRC-EXPR-CONV:out", *E);
+          DEBUG(std::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.
         ++NumExprTreesConv;
         return true;
@@ -283,20 +301,20 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
       ConvertedTypes.clear();
       // Make sure the source doesn't change type
       ConvertedTypes[Src] = Src->getType();
-      if (ValueConvertableToType(CI, Src->getType(), ConvertedTypes, TD)) {
-        PRINT_PEEPHOLE3("CAST-DEST-EXPR-CONV:in ", Src, CI, BB->getParent());
+      if (ValueConvertibleToType(CI, Src->getType(), ConvertedTypes, TD)) {
+        //PRINT_PEEPHOLE3("CAST-DEST-EXPR-CONV:in ", *Src, *CI,
+        //                *BB->getParent());
 
-        DEBUG(cerr << "\nCONVERTING EXPR TYPE:\n");
+        DEBUG(std::cerr << "\nCONVERTING EXPR TYPE:\n");
         { // ValueMap must be destroyed before function verified!
           ValueMapCache ValueMap;
           ConvertValueToNewType(CI, Src, ValueMap, TD);  // This will delete CI!
         }
 
-        PRINT_PEEPHOLE1("CAST-DEST-EXPR-CONV:out", Src);
-        DEBUG(cerr << "DONE CONVERTING EXPR TYPE: \n\n" << BB->getParent());
+        PRINT_PEEPHOLE1("CAST-DEST-EXPR-CONV:out", *Src);
+        DEBUG(std::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;
@@ -341,7 +359,7 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
           }
 
         // If it doesn't have an add use, check to see if the dest type is
-        // losslessly convertable to one of the types in the start of the struct
+        // losslessly convertible to one of the types in the start of the struct
         // type.
         //
         if (!HasAddUse) {
@@ -352,25 +370,26 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
 
           // Build the index vector, full of all zeros
           std::vector<Value*> Indices;
-          Indices.push_back(ConstantSInt::get(Type::LongTy, 0));
+
+          Indices.push_back(Constant::getNullValue(Type::UIntTy));
           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.
-              if (CurSTy->getElementTypes().size() == 0) break;
+              if (CurSTy->getNumElements() == 0) break;
             
               // Grab the first element of the struct type, which must lie at
               // offset zero in the struct.
               //
-              ElTy = CurSTy->getElementTypes()[0];
+              ElTy = CurSTy->getElementType(0);
             } else {
               ElTy = cast<ArrayType>(CurCTy)->getElementType();
             }
 
             // Insert a zero to index through this type...
-            Indices.push_back(Constant::getNullValue(CurCTy->getIndexType()));
+            Indices.push_back(Constant::getNullValue(Type::UIntTy));
 
             // Did we find what we're looking for?
-            if (ElTy->isLosslesslyConvertableTo(DestPointedTy)) break;
+            if (ElTy->isLosslesslyConvertibleTo(DestPointedTy)) break;
             
             // Nope, go a level deeper.
             ++Depth;
@@ -380,7 +399,7 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
           
           // Did we find what we were looking for? If so, do the transformation
           if (ElTy) {
-            PRINT_PEEPHOLE1("cast-for-first:in", CI);
+            PRINT_PEEPHOLE1("cast-for-first:in", *CI);
 
             std::string Name = CI->getName(); CI->setName("");
 
@@ -393,7 +412,7 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
             //
             CI->setOperand(0, GEP);
             
-            PRINT_PEEPHOLE2("cast-for-first:out", GEP, CI);
+            PRINT_PEEPHOLE2("cast-for-first:out", *GEP, *CI);
             ++NumGEPInstFormed;
             return true;
           }
@@ -405,7 +424,7 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
     Value *Pointer = SI->getPointerOperand();
     
     // Peephole optimize the following instructions:
-    // %t = cast <T1>* %P to <T2> * ;; If T1 is losslessly convertable to T2
+    // %t = cast <T1>* %P to <T2> * ;; If T1 is losslessly convertible to T2
     // store <T2> %V, <T2>* %t
     //
     // Into: 
@@ -420,9 +439,9 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
     if (CastInst *CI = dyn_cast<CastInst>(Pointer))
       if (Value *CastSrc = CI->getOperand(0)) // CSPT = CastSrcPointerType
         if (const PointerType *CSPT = dyn_cast<PointerType>(CastSrc->getType()))
-          // convertable types?
-          if (Val->getType()->isLosslesslyConvertableTo(CSPT->getElementType())) {
-            PRINT_PEEPHOLE3("st-src-cast:in ", Pointer, Val, SI);
+          // convertible types?
+          if (Val->getType()->isLosslesslyConvertibleTo(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("");
@@ -432,7 +451,7 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
             // Replace the old store with a new one!
             ReplaceInstWithInst(BB->getInstList(), BI,
                                 SI = new StoreInst(NCI, CastSrc));
-            PRINT_PEEPHOLE3("st-src-cast:out", NCI, CastSrc, SI);
+            PRINT_PEEPHOLE3("st-src-cast:out", *NCI, *CastSrc, *SI);
             ++NumLoadStorePeepholes;
             return true;
           }
@@ -443,7 +462,7 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
       cast<PointerType>(Pointer->getType())->getElementType();
     
     // Peephole optimize the following instructions:
-    // %Val = cast <T1>* to <T2>*    ;; If T1 is losslessly convertable to T2
+    // %Val = cast <T1>* to <T2>*    ;; If T1 is losslessly convertible to T2
     // %t = load <T2>* %P
     //
     // Into: 
@@ -458,9 +477,9 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
     if (CastInst *CI = dyn_cast<CastInst>(Pointer))
       if (Value *CastSrc = CI->getOperand(0)) // CSPT = CastSrcPointerType
         if (const PointerType *CSPT = dyn_cast<PointerType>(CastSrc->getType()))
-          // convertable types?
-          if (PtrElType->isLosslesslyConvertableTo(CSPT->getElementType())) {
-            PRINT_PEEPHOLE2("load-src-cast:in ", Pointer, LI);
+          // convertible types?
+          if (PtrElType->isLosslesslyConvertibleTo(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(), BI);
@@ -470,7 +489,7 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
 
             // Replace the old store with a new one!
             ReplaceInstWithInst(BB->getInstList(), BI, NCI);
-            PRINT_PEEPHOLE3("load-src-cast:out", NCI, CastSrc, NewLI);
+            PRINT_PEEPHOLE3("load-src-cast:out", *NCI, *CastSrc, *NewLI);
             ++NumLoadStorePeepholes;
             return true;
           }
@@ -491,7 +510,8 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
     const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
 
     // Is the call to a vararg variable with no real parameters?
-    if (FTy->isVarArg() && FTy->getNumParams() == 0) {
+    if (FTy->isVarArg() && FTy->getNumParams() == 0 &&
+        !CI->getCalledFunction()) {
       // If so, insert a new cast instruction, casting it to a function type
       // that matches the current arguments...
       //
@@ -504,8 +524,16 @@ bool RPR::PeepholeOptimize(BasicBlock *BB, BasicBlock::iterator &BI) {
       PointerType *NewPFunTy = PointerType::get(NewFT);
 
       // Create a new cast, inserting it right before the function call...
-      CastInst *NewCast = new CastInst(CI->getCalledValue(), NewPFunTy,
-                                       CI->getCalledValue()->getName(), CI);
+      Value *NewCast;
+      Constant *ConstantCallSrc = 0;
+      if (Constant *CS = dyn_cast<Constant>(CI->getCalledValue()))
+        ConstantCallSrc = CS;
+
+      if (ConstantCallSrc)
+        NewCast = ConstantExpr::getCast(ConstantCallSrc, NewPFunTy);
+      else
+        NewCast = new CastInst(CI->getCalledValue(), NewPFunTy,
+                               CI->getCalledValue()->getName()+"_c",CI);
 
       // Create a new call instruction...
       CallInst *NewCall = new CallInst(NewCast,
@@ -529,11 +557,11 @@ bool RPR::DoRaisePass(Function &F) {
   bool Changed = false;
   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(BI) || doConstantPropogation(BI)) {
+      DEBUG(std::cerr << "LevelRaising: " << *BI);
+      if (dceInstruction(BI) || doConstantPropagation(BI)) {
         Changed = true; 
         ++NumDCEorCP;
-        DEBUG(cerr << "***\t\t^^-- Dead code eliminated!\n");
+        DEBUG(std::cerr << "***\t\t^^-- Dead code eliminated!\n");
       } else if (PeepholeOptimize(BB, BI)) {
         Changed = true;
       } else {
@@ -547,7 +575,8 @@ bool RPR::DoRaisePass(Function &F) {
 
 // runOnFunction - Raise a function representation to a higher level.
 bool RPR::runOnFunction(Function &F) {
-  DEBUG(cerr << "\n\n\nStarting to work on Function '" << F.getName() << "'\n");
+  DEBUG(std::cerr << "\n\n\nStarting to work on Function '" << F.getName()
+                  << "'\n");
 
   // Insert casts for all incoming pointer pointer values that are treated as
   // arrays...
@@ -569,7 +598,7 @@ bool RPR::runOnFunction(Function &F) {
   }
 
   do {
-    DEBUG(cerr << "Looping: \n" << F);
+    DEBUG(std::cerr << "Looping: \n" << F);
 
     // Iterate over the function, refining it, until it converges on a stable
     // state
@@ -581,3 +610,4 @@ bool RPR::runOnFunction(Function &F) {
 
   return Changed;
 }
+