lib/Transforms/TransformInternals.cpp

   1 //===-- TransformInternals.cpp - Implement shared functions for transforms --=//
   2 //
   3 //  This file defines shared functions used by the different components of the
   4 //  Transforms library.
   5 //
   6 //===----------------------------------------------------------------------===//
   7
   8 #include "TransformInternals.h"
   9 #include "llvm/Method.h"
  10 #include "llvm/Type.h"
  11 #include "llvm/ConstantVals.h"
  12 #include "llvm/Analysis/Expressions.h"
  13 #include "llvm/iOther.h"
  14 #include <algorithm>
  15
  16 // TargetData Hack: Eventually we will have annotations given to us by the
  17 // backend so that we know stuff about type size and alignments.  For now
  18 // though, just use this, because it happens to match the model that GCC uses.
  19 //
  20 const TargetData TD("LevelRaise: Should be GCC though!");
  21
  22 // ReplaceInstWithValue - Replace all uses of an instruction (specified by BI)
  23 // with a value, then remove and delete the original instruction.
  24 //
  25 void ReplaceInstWithValue(BasicBlock::InstListType &BIL,
  26                           BasicBlock::iterator &BI, Value *V) {
  27   Instruction *I = *BI;
  28   // Replaces all of the uses of the instruction with uses of the value
  29   I->replaceAllUsesWith(V);
  30
  31   // Remove the unneccesary instruction now...
  32   BIL.remove(BI);
  33
  34   // Make sure to propogate a name if there is one already...
  35   if (I->hasName() && !V->hasName())
  36     V->setName(I->getName(), BIL.getParent()->getSymbolTable());
  37
  38   // Remove the dead instruction now...
  39   delete I;
  40 }
  41
  42
  43 // ReplaceInstWithInst - Replace the instruction specified by BI with the
  44 // instruction specified by I.  The original instruction is deleted and BI is
  45 // updated to point to the new instruction.
  46 //
  47 void ReplaceInstWithInst(BasicBlock::InstListType &BIL,
  48                          BasicBlock::iterator &BI, Instruction *I) {
  49   assert(I->getParent() == 0 &&
  50          "ReplaceInstWithInst: Instruction already inserted into basic block!");
  51
  52   // Insert the new instruction into the basic block...
  53   BI = BIL.insert(BI, I)+1;
  54
  55   // Replace all uses of the old instruction, and delete it.
  56   ReplaceInstWithValue(BIL, BI, I);
  57
  58   // Reexamine the instruction just inserted next time around the cleanup pass
  59   // loop.
  60   --BI;
  61 }
  62
  63 void ReplaceInstWithInst(Instruction *From, Instruction *To) {
  64   BasicBlock *BB = From->getParent();
  65   BasicBlock::InstListType &BIL = BB->getInstList();
  66   BasicBlock::iterator BI = find(BIL.begin(), BIL.end(), From);
  67   assert(BI != BIL.end() && "Inst not in it's parents BB!");
  68   ReplaceInstWithInst(BIL, BI, To);
  69 }
  70
  71
  72
  73 // getStructOffsetType - Return a vector of offsets that are to be used to index
  74 // into the specified struct type to get as close as possible to index as we
  75 // can.  Note that it is possible that we cannot get exactly to Offset, in which
  76 // case we update offset to be the offset we actually obtained.  The resultant
  77 // leaf type is returned.
  78 //
  79 // If StopEarly is set to true (the default), the first object with the
  80 // specified type is returned, even if it is a struct type itself.  In this
  81 // case, this routine will not drill down to the leaf type.  Set StopEarly to
  82 // false if you want a leaf
  83 //
  84 const Type *getStructOffsetType(const Type *Ty, unsigned &Offset,
  85                                 std::vector<Value*> &Offsets,
  86                                 bool StopEarly = true) {
  87   if (Offset == 0 && StopEarly && !Offsets.empty())
  88     return Ty;    // Return the leaf type
  89
  90   unsigned ThisOffset;
  91   const Type *NextType;
  92   if (const StructType *STy = dyn_cast<StructType>(Ty)) {
  93     assert(Offset < TD.getTypeSize(STy) && "Offset not in composite!");
  94     const StructLayout *SL = TD.getStructLayout(STy);
  95
  96     // This loop terminates always on a 0 <= i < MemberOffsets.size()
  97     unsigned i;
  98     for (i = 0; i < SL->MemberOffsets.size()-1; ++i)
  99       if (Offset >= SL->MemberOffsets[i] && Offset <  SL->MemberOffsets[i+1])
 100         break;
 101
 102     assert(Offset >= SL->MemberOffsets[i] &&
 103            (i == SL->MemberOffsets.size()-1 || Offset <SL->MemberOffsets[i+1]));
 104
 105     // Make sure to save the current index...
 106     Offsets.push_back(ConstantUInt::get(Type::UByteTy, i));
 107     ThisOffset = SL->MemberOffsets[i];
 108     NextType = STy->getElementTypes()[i];
 109   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 110     assert(Offset < TD.getTypeSize(ATy) && "Offset not in composite!");
 111
 112     NextType = ATy->getElementType();
 113     unsigned ChildSize = TD.getTypeSize(NextType);
 114     Offsets.push_back(ConstantUInt::get(Type::UIntTy, Offset/ChildSize));
 115     ThisOffset = (Offset/ChildSize)*ChildSize;
 116   } else {
 117     Offset = 0;   // Return the offset that we were able to acheive
 118     return Ty;    // Return the leaf type
 119   }
 120
 121   unsigned SubOffs = Offset - ThisOffset;
 122   const Type *LeafTy = getStructOffsetType(NextType, SubOffs, Offsets);
 123   Offset = ThisOffset + SubOffs;
 124   return LeafTy;
 125 }
 126
 127 // ConvertableToGEP - This function returns true if the specified value V is
 128 // a valid index into a pointer of type Ty.  If it is valid, Idx is filled in
 129 // with the values that would be appropriate to make this a getelementptr
 130 // instruction.  The type returned is the root type that the GEP would point to
 131 //
 132 const Type *ConvertableToGEP(const Type *Ty, Value *OffsetVal,
 133                              std::vector<Value*> &Indices,
 134                              BasicBlock::iterator *BI = 0) {
 135   const CompositeType *CompTy = dyn_cast<CompositeType>(Ty);
 136   if (CompTy == 0) return 0;
 137
 138   // See if the cast is of an integer expression that is either a constant,
 139   // or a value scaled by some amount with a possible offset.
 140   //
 141   analysis::ExprType Expr = analysis::ClassifyExpression(OffsetVal);
 142
 143   // Get the offset and scale now...
 144   unsigned Offset = 0, Scale = Expr.Var != 0;
 145
 146   // Get the offset value if it exists...
 147   if (Expr.Offset) {
 148     int Val = getConstantValue(Expr.Offset);
 149     if (Val < 0) return false;  // Don't mess with negative offsets
 150     Offset = (unsigned)Val;
 151   }
 152
 153   // Get the scale value if it exists...
 154   if (Expr.Scale) {
 155     int Val = getConstantValue(Expr.Scale);
 156     if (Val < 0) return false;  // Don't mess with negative scales
 157     Scale = (unsigned)Val;
 158   }
 159
 160   // Loop over the Scale and Offset values, filling in the Indices vector for
 161   // our final getelementptr instruction.
 162   //
 163   const Type *NextTy = CompTy;
 164   do {
 165     if (!isa<CompositeType>(NextTy))
 166       return 0;  // Type must not be ready for processing...
 167     CompTy = cast<CompositeType>(NextTy);
 168
 169     if (const StructType *StructTy = dyn_cast<StructType>(CompTy)) {
 170       const StructLayout *SL = TD.getStructLayout(StructTy);
 171       unsigned ActualOffset = Offset;
 172       NextTy = getStructOffsetType(StructTy, ActualOffset, Indices);
 173       if (StructTy == NextTy && ActualOffset == 0) return 0; // No progress.  :(
 174       Offset -= ActualOffset;
 175     } else {
 176       const Type *ElTy = cast<SequentialType>(CompTy)->getElementType();
 177       if (!ElTy->isSized()) return 0; // Type is unreasonable... escape!
 178       unsigned ElSize = TD.getTypeSize(ElTy);
 179
 180       // See if the user is indexing into a different cell of this array...
 181       if (Scale && Scale >= ElSize) {
 182         // A scale n*ElSize might occur if we are not stepping through
 183         // array by one.  In this case, we will have to insert math to munge
 184         // the index.
 185         //
 186         unsigned ScaleAmt = Scale/ElSize;
 187         if (Scale-ScaleAmt*ElSize)
 188           return 0;  // Didn't scale by a multiple of element size, bail out
 189         Scale = 0;   // Scale is consumed
 190
 191         unsigned Index = Offset/ElSize;       // is zero unless Offset > ElSize
 192         Offset -= Index*ElSize;               // Consume part of the offset
 193
 194         if (BI) {              // Generate code?
 195           BasicBlock *BB = (**BI)->getParent();
 196           if (Expr.Var->getType() != Type::UIntTy) {
 197             CastInst *IdxCast = new CastInst(Expr.Var, Type::UIntTy);
 198             if (Expr.Var->hasName())
 199               IdxCast->setName(Expr.Var->getName()+"-idxcast");
 200             *BI = BB->getInstList().insert(*BI, IdxCast)+1;
 201             Expr.Var = IdxCast;
 202           }
 203
 204           if (ScaleAmt && ScaleAmt != 1) {
 205             // If we have to scale up our index, do so now
 206             Value *ScaleAmtVal = ConstantUInt::get(Type::UIntTy, ScaleAmt);
 207             Instruction *Scaler = BinaryOperator::create(Instruction::Mul,
 208                                                          Expr.Var,ScaleAmtVal);
 209             if (Expr.Var->hasName())
 210               Scaler->setName(Expr.Var->getName()+"-scale");
 211
 212             *BI = BB->getInstList().insert(*BI, Scaler)+1;
 213             Expr.Var = Scaler;
 214           }
 215
 216           if (Index) {  // Add an offset to the index
 217             Value *IndexAmt = ConstantUInt::get(Type::UIntTy, Index);
 218             Instruction *Offseter = BinaryOperator::create(Instruction::Add,
 219                                                            Expr.Var, IndexAmt);
 220             if (Expr.Var->hasName())
 221               Offseter->setName(Expr.Var->getName()+"-offset");
 222             *BI = BB->getInstList().insert(*BI, Offseter)+1;
 223             Expr.Var = Offseter;
 224           }
 225         }
 226
 227         Indices.push_back(Expr.Var);
 228       } else if (Offset >= ElSize) {
 229         // Calculate the index that we are entering into the array cell with
 230         unsigned Index = Offset/ElSize;
 231         Indices.push_back(ConstantUInt::get(Type::UIntTy, Index));
 232         Offset -= Index*ElSize;               // Consume part of the offset
 233
 234       } else if (!isa<PointerType>(CompTy) || CompTy == Ty) {
 235         // Must be indexing a small amount into the first cell of the array
 236         // Just index into element zero of the array here.
 237         //
 238         Indices.push_back(ConstantUInt::get(Type::UIntTy, 0));
 239       } else {
 240         return 0;  // Hrm. wierd, can't handle this case.  Bail
 241       }
 242       NextTy = ElTy;
 243     }
 244   } while (Offset || Scale);    // Go until we're done!
 245
 246   return NextTy;
 247 }