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/Type.h"
  10 #include "llvm/Analysis/Expressions.h"
  11 #include "llvm/Function.h"
  12 #include "llvm/iOther.h"
  13
  14 // TargetData Hack: Eventually we will have annotations given to us by the
  15 // backend so that we know stuff about type size and alignments.  For now
  16 // though, just use this, because it happens to match the model that GCC uses.
  17 //
  18 const TargetData TD("LevelRaise: Should be GCC though!");
  19
  20
  21 static const Type *getStructOffsetStep(const StructType *STy, unsigned &Offset,
  22                                        std::vector<Value*> &Indices) {
  23   assert(Offset < TD.getTypeSize(STy) && "Offset not in composite!");
  24   const StructLayout *SL = TD.getStructLayout(STy);
  25
  26   // This loop terminates always on a 0 <= i < MemberOffsets.size()
  27   unsigned i;
  28   for (i = 0; i < SL->MemberOffsets.size()-1; ++i)
  29     if (Offset >= SL->MemberOffsets[i] && Offset < SL->MemberOffsets[i+1])
  30       break;
  31
  32   assert(Offset >= SL->MemberOffsets[i] &&
  33          (i == SL->MemberOffsets.size()-1 || Offset < SL->MemberOffsets[i+1]));
  34
  35   // Make sure to save the current index...
  36   Indices.push_back(ConstantUInt::get(Type::UByteTy, i));
  37   Offset = SL->MemberOffsets[i];
  38   return STy->getContainedType(i);
  39 }
  40
  41
  42 // getStructOffsetType - Return a vector of offsets that are to be used to index
  43 // into the specified struct type to get as close as possible to index as we
  44 // can.  Note that it is possible that we cannot get exactly to Offset, in which
  45 // case we update offset to be the offset we actually obtained.  The resultant
  46 // leaf type is returned.
  47 //
  48 // If StopEarly is set to true (the default), the first object with the
  49 // specified type is returned, even if it is a struct type itself.  In this
  50 // case, this routine will not drill down to the leaf type.  Set StopEarly to
  51 // false if you want a leaf
  52 //
  53 const Type *getStructOffsetType(const Type *Ty, unsigned &Offset,
  54                                 std::vector<Value*> &Indices,
  55                                 bool StopEarly) {
  56   if (Offset == 0 && StopEarly && !Indices.empty())
  57     return Ty;    // Return the leaf type
  58
  59   unsigned ThisOffset;
  60   const Type *NextType;
  61   if (const StructType *STy = dyn_cast<StructType>(Ty)) {
  62     ThisOffset = Offset;
  63     NextType = getStructOffsetStep(STy, ThisOffset, Indices);
  64   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
  65     assert(Offset < TD.getTypeSize(ATy) && "Offset not in composite!");
  66
  67     NextType = ATy->getElementType();
  68     unsigned ChildSize = TD.getTypeSize(NextType);
  69     Indices.push_back(ConstantUInt::get(Type::UIntTy, Offset/ChildSize));
  70     ThisOffset = (Offset/ChildSize)*ChildSize;
  71   } else {
  72     Offset = 0;   // Return the offset that we were able to acheive
  73     return Ty;    // Return the leaf type
  74   }
  75
  76   unsigned SubOffs = Offset - ThisOffset;
  77   const Type *LeafTy = getStructOffsetType(NextType, SubOffs,
  78                                            Indices, StopEarly);
  79   Offset = ThisOffset + SubOffs;
  80   return LeafTy;
  81 }
  82
  83 // ConvertableToGEP - This function returns true if the specified value V is
  84 // a valid index into a pointer of type Ty.  If it is valid, Idx is filled in
  85 // with the values that would be appropriate to make this a getelementptr
  86 // instruction.  The type returned is the root type that the GEP would point to
  87 //
  88 const Type *ConvertableToGEP(const Type *Ty, Value *OffsetVal,
  89                              std::vector<Value*> &Indices,
  90                              BasicBlock::iterator *BI) {
  91   const CompositeType *CompTy = dyn_cast<CompositeType>(Ty);
  92   if (CompTy == 0) return 0;
  93
  94   // See if the cast is of an integer expression that is either a constant,
  95   // or a value scaled by some amount with a possible offset.
  96   //
  97   ExprType Expr = ClassifyExpression(OffsetVal);
  98
  99   // Get the offset and scale values if they exists...
 100   // A scale of zero with Expr.Var != 0 means a scale of 1.
 101   //
 102   int Offset = Expr.Offset ? getConstantValue(Expr.Offset) : 0;
 103   int Scale  = Expr.Scale  ? getConstantValue(Expr.Scale)  : 0;
 104
 105   if (Expr.Var && Scale == 0) Scale = 1;   // Scale != 0 if Expr.Var != 0
 106
 107   // Loop over the Scale and Offset values, filling in the Indices vector for
 108   // our final getelementptr instruction.
 109   //
 110   const Type *NextTy = CompTy;
 111   do {
 112     if (!isa<CompositeType>(NextTy))
 113       return 0;  // Type must not be ready for processing...
 114     CompTy = cast<CompositeType>(NextTy);
 115
 116     if (const StructType *StructTy = dyn_cast<StructType>(CompTy)) {
 117       // Step into the appropriate element of the structure...
 118       unsigned ActualOffset = (Offset < 0) ? 0 : (unsigned)Offset;
 119       NextTy = getStructOffsetStep(StructTy, ActualOffset, Indices);
 120       Offset -= ActualOffset;
 121     } else {
 122       const Type *ElTy = cast<SequentialType>(CompTy)->getElementType();
 123       if (!ElTy->isSized())
 124         return 0; // Type is unreasonable... escape!
 125       unsigned ElSize = TD.getTypeSize(ElTy);
 126       int ElSizeS = (int)ElSize;
 127
 128       // See if the user is indexing into a different cell of this array...
 129       if (Scale && (Scale >= ElSizeS || -Scale >= ElSizeS)) {
 130         // A scale n*ElSize might occur if we are not stepping through
 131         // array by one.  In this case, we will have to insert math to munge
 132         // the index.
 133         //
 134         int ScaleAmt = Scale/ElSizeS;
 135         if (Scale-ScaleAmt*ElSizeS)
 136           return 0;  // Didn't scale by a multiple of element size, bail out
 137         Scale = 0;   // Scale is consumed
 138
 139         int Index = Offset/ElSize;            // is zero unless Offset > ElSize
 140         Offset -= Index*ElSize;               // Consume part of the offset
 141
 142         if (BI) {              // Generate code?
 143           BasicBlock *BB = (*BI)->getParent();
 144           if (Expr.Var->getType() != Type::UIntTy) {
 145             CastInst *IdxCast = new CastInst(Expr.Var, Type::UIntTy);
 146             if (Expr.Var->hasName())
 147               IdxCast->setName(Expr.Var->getName()+"-idxcast");
 148             *BI = ++BB->getInstList().insert(*BI, IdxCast);
 149             Expr.Var = IdxCast;
 150           }
 151
 152           if (ScaleAmt && ScaleAmt != 1) {
 153             // If we have to scale up our index, do so now
 154             Value *ScaleAmtVal = ConstantUInt::get(Type::UIntTy,
 155                                                    (unsigned)ScaleAmt);
 156             Instruction *Scaler = BinaryOperator::create(Instruction::Mul,
 157                                                          Expr.Var, ScaleAmtVal);
 158             if (Expr.Var->hasName())
 159               Scaler->setName(Expr.Var->getName()+"-scale");
 160
 161             *BI = ++BB->getInstList().insert(*BI, Scaler);
 162             Expr.Var = Scaler;
 163           }
 164
 165           if (Index) {  // Add an offset to the index
 166             Value *IndexAmt = ConstantUInt::get(Type::UIntTy, (unsigned)Index);
 167             Instruction *Offseter = BinaryOperator::create(Instruction::Add,
 168                                                            Expr.Var, IndexAmt);
 169             if (Expr.Var->hasName())
 170               Offseter->setName(Expr.Var->getName()+"-offset");
 171             *BI = ++BB->getInstList().insert(*BI, Offseter);
 172             Expr.Var = Offseter;
 173           }
 174         }
 175
 176         Indices.push_back(Expr.Var);
 177         Expr.Var = 0;
 178       } else if (Offset >= (int)ElSize || -Offset >= (int)ElSize) {
 179         // Calculate the index that we are entering into the array cell with
 180         unsigned Index = Offset/ElSize;
 181         Indices.push_back(ConstantUInt::get(Type::UIntTy, Index));
 182         Offset -= (int)(Index*ElSize);            // Consume part of the offset
 183
 184       } else if (isa<ArrayType>(CompTy) || Indices.empty()) {
 185         // Must be indexing a small amount into the first cell of the array
 186         // Just index into element zero of the array here.
 187         //
 188         Indices.push_back(ConstantUInt::get(Type::UIntTy, 0));
 189       } else {
 190         return 0;  // Hrm. wierd, can't handle this case.  Bail
 191       }
 192       NextTy = ElTy;
 193     }
 194   } while (Offset || Scale);    // Go until we're done!
 195
 196   return NextTy;
 197 }