lib/Transforms/Scalar/DecomposeMultiDimRefs.cpp

   1 //===- llvm/Transforms/DecomposeMultiDimRefs.cpp - Lower array refs to 1D -===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // DecomposeMultiDimRefs - Convert multi-dimensional references consisting of
  11 // any combination of 2 or more array and structure indices into a sequence of
  12 // instructions (using getelementpr and cast) so that each instruction has at
  13 // most one index (except structure references, which need an extra leading
  14 // index of [0]).
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "llvm/Transforms/Scalar.h"
  19 #include "llvm/DerivedTypes.h"
  20 #include "llvm/Constants.h"
  21 #include "llvm/Constant.h"
  22 #include "llvm/iMemory.h"
  23 #include "llvm/iOther.h"
  24 #include "llvm/BasicBlock.h"
  25 #include "llvm/Pass.h"
  26 #include "Support/Statistic.h"
  27 #include "Support/Debug.h"
  28 using namespace llvm;
  29
  30 namespace {
  31   Statistic<> NumAdded("lowerrefs", "# of getelementptr instructions added");
  32
  33   struct DecomposePass : public BasicBlockPass {
  34     virtual bool runOnBasicBlock(BasicBlock &BB);
  35   };
  36   RegisterOpt<DecomposePass> X("lowerrefs", "Decompose multi-dimensional "
  37                                "structure/array references");
  38 }
  39
  40 // runOnBasicBlock - Entry point for array or structure references with multiple
  41 // indices.
  42 //
  43 bool DecomposePass::runOnBasicBlock(BasicBlock &BB) {
  44   bool changed = false;
  45   for (BasicBlock::iterator II = BB.begin(); II != BB.end(); )
  46     if (GetElementPtrInst *gep = dyn_cast<GetElementPtrInst>(II++)) // pre-inc
  47       if (gep->getNumIndices() >= 2)
  48         changed |= DecomposeArrayRef(gep); // always modifies II
  49   return changed;
  50 }
  51
  52 FunctionPass *llvm::createDecomposeMultiDimRefsPass() {
  53   return new DecomposePass();
  54 }
  55
  56 static inline bool isZeroConst (Value *V) {
  57   return isa<Constant> (V) && (cast<Constant>(V)->isNullValue());
  58 }
  59
  60 // Function: DecomposeArrayRef()
  61 //
  62 // For any GetElementPtrInst with 2 or more array and structure indices:
  63 //
  64 //      opCode CompositeType* P, [uint|ubyte] idx1, ..., [uint|ubyte] idxN
  65 //
  66 // this function generates the following sequence:
  67 //
  68 //      ptr1   = getElementPtr P,         idx1
  69 //      ptr2   = getElementPtr ptr1,   0, idx2
  70 //      ...
  71 //      ptrN-1 = getElementPtr ptrN-2, 0, idxN-1
  72 //      opCode                 ptrN-1, 0, idxN  // New-MAI
  73 //
  74 // Then it replaces the original instruction with this sequence,
  75 // and replaces all uses of the original instruction with New-MAI.
  76 // If idx1 is 0, we simply omit the first getElementPtr instruction.
  77 //
  78 // On return: BBI points to the instruction after the current one
  79 //            (whether or not *BBI was replaced).
  80 //
  81 // Return value: true if the instruction was replaced; false otherwise.
  82 //
  83 bool llvm::DecomposeArrayRef(GetElementPtrInst* GEP) {
  84   if (GEP->getNumIndices() < 2
  85       || (GEP->getNumIndices() == 2
  86           && isZeroConst(GEP->getOperand(1)))) {
  87     DEBUG (std::cerr << "DecomposeArrayRef: Skipping " << *GEP);
  88     return false;
  89   } else {
  90     DEBUG (std::cerr << "DecomposeArrayRef: Decomposing " << *GEP);
  91   }
  92
  93   BasicBlock *BB = GEP->getParent();
  94   Value *LastPtr = GEP->getPointerOperand();
  95   Instruction *InsertPoint = GEP->getNext(); // Insert before the next insn
  96
  97   // Process each index except the last one.
  98   User::const_op_iterator OI = GEP->idx_begin(), OE = GEP->idx_end();
  99   for (; OI+1 != OE; ++OI) {
 100     std::vector<Value*> Indices;
 101
 102     // If this is the first index and is 0, skip it and move on!
 103     if (OI == GEP->idx_begin()) {
 104       if (isZeroConst (*OI))
 105         continue;
 106     }
 107     else // Not the first index: include initial [0] to deref the last ptr
 108       Indices.push_back(Constant::getNullValue(Type::LongTy));
 109
 110     Indices.push_back(*OI);
 111
 112     // New Instruction: nextPtr1 = GetElementPtr LastPtr, Indices
 113     LastPtr = new GetElementPtrInst(LastPtr, Indices, "ptr1", InsertPoint);
 114     ++NumAdded;
 115   }
 116
 117   // Now create a new instruction to replace the original one
 118   //
 119   const PointerType *PtrTy = cast<PointerType>(LastPtr->getType());
 120
 121   // Get the final index vector, including an initial [0] as before.
 122   std::vector<Value*> Indices;
 123   Indices.push_back(Constant::getNullValue(Type::LongTy));
 124   Indices.push_back(*OI);
 125
 126   Value *NewVal = new GetElementPtrInst(LastPtr, Indices, GEP->getName(),
 127                                         InsertPoint);
 128
 129   // Replace all uses of the old instruction with the new
 130   GEP->replaceAllUsesWith(NewVal);
 131
 132   // Now remove and delete the old instruction...
 133   BB->getInstList().erase(GEP);
 134
 135   return true;
 136 }
 137