lib/Transforms/Scalar/ConstantProp.cpp

   1 //===- ConstantProp.cpp - Code to perform Constant Propogation ------------===//
   2 //
   3 // This file implements constant propogation and merging:
   4 //
   5 // Specifically, this:
   6 //   * Folds multiple identical constants in the constant pool together
   7 //     Note that if one is named and the other is not, that the result gets the
   8 //     original name.
   9 //   * Converts instructions like "add int %1, %2" into a direct def of %3 in
  10 //     the constant pool
  11 //   * Converts conditional branches on a constant boolean value into direct
  12 //     branches.
  13 //   * Converts phi nodes with one incoming def to the incoming def directly
  14 //   . Converts switch statements with one entry into a test & conditional
  15 //     branch
  16 //   . Converts switches on constant values into an unconditional branch.
  17 //
  18 // Notice that:
  19 //   * This pass has a habit of making definitions be dead.  It is a good idea
  20 //     to to run a DCE pass sometime after running this pass.
  21 //
  22 //===----------------------------------------------------------------------===//
  23
  24 #include "llvm/Module.h"
  25 #include "llvm/Method.h"
  26 #include "llvm/BasicBlock.h"
  27 #include "llvm/iTerminators.h"
  28 #include "llvm/iOther.h"
  29 #include "llvm/ConstPoolVals.h"
  30 #include "llvm/ConstantPool.h"
  31 #include "llvm/Opt/AllOpts.h"
  32 #include "llvm/Opt/ConstantHandling.h"
  33
  34 // Merge identical constant values in the constant pool.
  35 //
  36 // TODO: We can do better than this simplistic N^2 algorithm...
  37 //
  38 bool DoConstantPoolMerging(Method *M) {
  39   return DoConstantPoolMerging(M->getConstantPool());
  40 }
  41
  42 bool DoConstantPoolMerging(ConstantPool &CP) {
  43   bool Modified = false;
  44   for (ConstantPool::plane_iterator PI = CP.begin(); PI != CP.end(); ++PI) {
  45     for (ConstantPool::PlaneType::iterator I = (*PI)->begin();
  46          I != (*PI)->end(); ++I) {
  47       ConstPoolVal *C = *I;
  48
  49       ConstantPool::PlaneType::iterator J = I;
  50       for (++J; J != (*PI)->end(); ++J) {
  51         if (C->equals(*J)) {
  52           Modified = true;
  53           // Okay we know that *I == *J.  So now we need to make all uses of *I
  54           // point to *J.
  55           //
  56           C->replaceAllUsesWith(*J);
  57
  58           (*PI)->remove(I); // Remove C from constant pool...
  59
  60           if (C->hasName() && !(*J)->hasName())  // The merged constant inherits
  61             (*J)->setName(C->getName());         // the old name...
  62
  63           delete C;                              // Delete the constant itself.
  64           break;  // Break out of inner for loop
  65         }
  66       }
  67     }
  68   }
  69   return Modified;
  70 }
  71
  72 inline static bool
  73 ConstantFoldUnaryInst(Method *M, Method::inst_iterator &DI,
  74                       UnaryOperator *Op, ConstPoolVal *D) {
  75   ConstPoolVal *ReplaceWith =
  76     ConstantFoldUnaryInstruction(Op->getInstType(), D);
  77
  78   if (!ReplaceWith) return false;   // Nothing new to change...
  79
  80
  81   // Add the new value to the constant pool...
  82   M->getConstantPool().insert(ReplaceWith);
  83
  84   // Replaces all of the uses of a variable with uses of the constant.
  85   Op->replaceAllUsesWith(ReplaceWith);
  86
  87   // Remove the operator from the list of definitions...
  88   Op->getParent()->getInstList().remove(DI.getInstructionIterator());
  89
  90   // The new constant inherits the old name of the operator...
  91   if (Op->hasName()) ReplaceWith->setName(Op->getName());
  92
  93   // Delete the operator now...
  94   delete Op;
  95   return true;
  96 }
  97
  98 inline static bool
  99 ConstantFoldBinaryInst(Method *M, Method::inst_iterator &DI,
 100                        BinaryOperator *Op,
 101                        ConstPoolVal *D1, ConstPoolVal *D2) {
 102   ConstPoolVal *ReplaceWith =
 103     ConstantFoldBinaryInstruction(Op->getInstType(), D1, D2);
 104   if (!ReplaceWith) return false;   // Nothing new to change...
 105
 106   // Add the new value to the constant pool...
 107   M->getConstantPool().insert(ReplaceWith);
 108
 109   // Replaces all of the uses of a variable with uses of the constant.
 110   Op->replaceAllUsesWith(ReplaceWith);
 111
 112   // Remove the operator from the list of definitions...
 113   Op->getParent()->getInstList().remove(DI.getInstructionIterator());
 114
 115   // The new constant inherits the old name of the operator...
 116   if (Op->hasName()) ReplaceWith->setName(Op->getName());
 117
 118   // Delete the operator now...
 119   delete Op;
 120   return true;
 121 }
 122
 123 inline static bool ConstantFoldTerminator(TerminatorInst *T) {
 124   // Branch - See if we are conditional jumping on constant
 125   if (T->getInstType() == Instruction::Br) {
 126     BranchInst *BI = (BranchInst*)T;
 127     if (!BI->isUnconditional() &&              // Are we branching on constant?
 128         BI->getOperand(2)->isConstant()) {
 129       // YES.  Change to unconditional branch...
 130       ConstPoolBool *Cond = (ConstPoolBool*)BI->getOperand(2);
 131       Value *Destination = BI->getOperand(Cond->getValue() ? 0 : 1);
 132
 133       BI->setOperand(0, Destination);  // Set the unconditional destination
 134       BI->setOperand(1, 0);            // Clear the conditional destination
 135       BI->setOperand(2, 0);            // Clear the condition...
 136       return true;
 137     }
 138   }
 139   return false;
 140 }
 141
 142 // ConstantFoldInstruction - If an instruction references constants, try to fold
 143 // them together...
 144 //
 145 inline static bool
 146 ConstantFoldInstruction(Method *M, Method::inst_iterator &II) {
 147   Instruction *Inst = *II;
 148   if (Inst->isBinaryOp()) {
 149     ConstPoolVal *D1 = Inst->getOperand(0)->castConstant();
 150     ConstPoolVal *D2 = Inst->getOperand(1)->castConstant();
 151
 152     if (D1 && D2)
 153       return ConstantFoldBinaryInst(M, II, (BinaryOperator*)Inst, D1, D2);
 154
 155   } else if (Inst->isUnaryOp()) {
 156     ConstPoolVal *D = Inst->getOperand(0)->castConstant();
 157     if (D) return ConstantFoldUnaryInst(M, II, (UnaryOperator*)Inst, D);
 158   } else if (Inst->isTerminator()) {
 159     return ConstantFoldTerminator((TerminatorInst*)Inst);
 160
 161   } else if (Inst->isPHINode()) {
 162     PHINode *PN = (PHINode*)Inst; // If it's a PHI node and only has one operand
 163                                   // Then replace it directly with that operand.
 164     assert(PN->getOperand(0) && "PHI Node must have at least one operand!");
 165     if (PN->getOperand(1) == 0) {       // If the PHI Node has exactly 1 operand
 166       Value *V = PN->getOperand(0);
 167       PN->replaceAllUsesWith(V);                 // Replace all uses of this PHI
 168                                                  // Unlink from basic block
 169       PN->getParent()->getInstList().remove(II.getInstructionIterator());
 170       if (PN->hasName()) V->setName(PN->getName()); // Inherit PHINode name
 171       delete PN;                                 // Finally, delete the node...
 172       return true;
 173     }
 174   }
 175   return false;
 176 }
 177
 178 // DoConstPropPass - Propogate constants and do constant folding on instructions
 179 // this returns true if something was changed, false if nothing was changed.
 180 //
 181 static bool DoConstPropPass(Method *M) {
 182   bool SomethingChanged = false;
 183
 184 #if 1
 185   Method::inst_iterator It = M->inst_begin();
 186   while (It != M->inst_end())
 187     if (ConstantFoldInstruction(M, It)) {
 188       SomethingChanged = true;  // If returned true, iter is already incremented
 189
 190       // Incrementing the iterator in an unchecked manner could mess up the
 191       // internals of 'It'.  To make sure everything is happy, tell it we might
 192       // have broken it.
 193       It.resyncInstructionIterator();
 194     } else {
 195       ++It;
 196     }
 197 #else
 198   for (Method::iterator BBIt = M->begin(); BBIt != M->end(); ++BBIt) {
 199     BasicBlock *BB = *BBIt;
 200
 201     reduce_apply_bool(BB->begin(), BB->end(),
 202                       bind1st(ConstantFoldInstruction, M));
 203   }
 204 #endif
 205   return SomethingChanged;
 206 }
 207
 208
 209 // returns true on failure, false on success...
 210 //
 211 bool DoConstantPropogation(Method *M) {
 212   bool Modified = false;
 213
 214   // Fold constants until we make no progress...
 215   while (DoConstPropPass(M)) Modified = true;
 216
 217   // Merge identical constants last: this is important because we may have just
 218   // introduced constants that already exist!
 219   //
 220   Modified |= DoConstantPoolMerging(M->getConstantPool());
 221
 222   return Modified;
 223 }