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