lib/Transforms/Utils/LowerSwitch.cpp

   1 //===- LowerSwitch.cpp - Eliminate Switch instructions --------------------===//
   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 // The LowerSwitch transformation rewrites switch statements with a sequence of
  11 // branches, which allows targets to get away with not implementing the switch
  12 // statement until it is convenient.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/Transforms/Scalar.h"
  17 #include "llvm/Transforms/Utils/UnifyFunctionExitNodes.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/Function.h"
  20 #include "llvm/Instructions.h"
  21 #include "llvm/Pass.h"
  22 #include "llvm/Support/Debug.h"
  23 #include "llvm/Support/Compiler.h"
  24 #include "llvm/ADT/Statistic.h"
  25 #include <algorithm>
  26 #include <iostream>
  27 using namespace llvm;
  28
  29 namespace {
  30   Statistic<> NumLowered("lowerswitch", "Number of SwitchInst's replaced");
  31
  32   /// LowerSwitch Pass - Replace all SwitchInst instructions with chained branch
  33   /// instructions.  Note that this cannot be a BasicBlock pass because it
  34   /// modifies the CFG!
  35   class VISIBILITY_HIDDEN LowerSwitch : public FunctionPass {
  36   public:
  37     virtual bool runOnFunction(Function &F);
  38
  39     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  40       // This is a cluster of orthogonal Transforms
  41       AU.addPreserved<UnifyFunctionExitNodes>();
  42       AU.addPreservedID(PromoteMemoryToRegisterID);
  43       AU.addPreservedID(LowerSelectID);
  44       AU.addPreservedID(LowerInvokePassID);
  45       AU.addPreservedID(LowerAllocationsID);
  46     }
  47
  48     typedef std::pair<Constant*, BasicBlock*> Case;
  49     typedef std::vector<Case>::iterator       CaseItr;
  50   private:
  51     void processSwitchInst(SwitchInst *SI);
  52
  53     BasicBlock* switchConvert(CaseItr Begin, CaseItr End, Value* Val,
  54                               BasicBlock* OrigBlock, BasicBlock* Default);
  55     BasicBlock* newLeafBlock(Case& Leaf, Value* Val,
  56                              BasicBlock* OrigBlock, BasicBlock* Default);
  57   };
  58
  59   /// The comparison function for sorting the switch case values in the vector.
  60   struct CaseCmp {
  61     bool operator () (const LowerSwitch::Case& C1,
  62                       const LowerSwitch::Case& C2) {
  63
  64       const ConstantInt* CI1 = cast<const ConstantInt>(C1.first);
  65       const ConstantInt* CI2 = cast<const ConstantInt>(C2.first);
  66       if (CI1->getType()->isUnsigned())
  67         return CI1->getZExtValue() < CI2->getZExtValue();
  68       return CI1->getSExtValue() < CI2->getSExtValue();
  69     }
  70   };
  71
  72   RegisterPass<LowerSwitch>
  73   X("lowerswitch", "Lower SwitchInst's to branches");
  74 }
  75
  76 // Publically exposed interface to pass...
  77 const PassInfo *llvm::LowerSwitchID = X.getPassInfo();
  78 // createLowerSwitchPass - Interface to this file...
  79 FunctionPass *llvm::createLowerSwitchPass() {
  80   return new LowerSwitch();
  81 }
  82
  83 bool LowerSwitch::runOnFunction(Function &F) {
  84   bool Changed = false;
  85
  86   for (Function::iterator I = F.begin(), E = F.end(); I != E; ) {
  87     BasicBlock *Cur = I++; // Advance over block so we don't traverse new blocks
  88
  89     if (SwitchInst *SI = dyn_cast<SwitchInst>(Cur->getTerminator())) {
  90       Changed = true;
  91       processSwitchInst(SI);
  92     }
  93   }
  94
  95   return Changed;
  96 }
  97
  98 // operator<< - Used for debugging purposes.
  99 //
 100 std::ostream& operator<<(std::ostream &O,
 101                          const std::vector<LowerSwitch::Case> &C) {
 102   O << "[";
 103
 104   for (std::vector<LowerSwitch::Case>::const_iterator B = C.begin(),
 105          E = C.end(); B != E; ) {
 106     O << *B->first;
 107     if (++B != E) O << ", ";
 108   }
 109
 110   return O << "]";
 111 }
 112
 113 // switchConvert - Convert the switch statement into a binary lookup of
 114 // the case values. The function recursively builds this tree.
 115 //
 116 BasicBlock* LowerSwitch::switchConvert(CaseItr Begin, CaseItr End,
 117                                        Value* Val, BasicBlock* OrigBlock,
 118                                        BasicBlock* Default)
 119 {
 120   unsigned Size = End - Begin;
 121
 122   if (Size == 1)
 123     return newLeafBlock(*Begin, Val, OrigBlock, Default);
 124
 125   unsigned Mid = Size / 2;
 126   std::vector<Case> LHS(Begin, Begin + Mid);
 127   DEBUG(std::cerr << "LHS: " << LHS << "\n");
 128   std::vector<Case> RHS(Begin + Mid, End);
 129   DEBUG(std::cerr << "RHS: " << RHS << "\n");
 130
 131   Case& Pivot = *(Begin + Mid);
 132   DEBUG(std::cerr << "Pivot ==> "
 133                   << cast<ConstantInt>(Pivot.first)->getSExtValue()
 134                   << "\n");
 135
 136   BasicBlock* LBranch = switchConvert(LHS.begin(), LHS.end(), Val,
 137                                       OrigBlock, Default);
 138   BasicBlock* RBranch = switchConvert(RHS.begin(), RHS.end(), Val,
 139                                       OrigBlock, Default);
 140
 141   // Create a new node that checks if the value is < pivot. Go to the
 142   // left branch if it is and right branch if not.
 143   Function* F = OrigBlock->getParent();
 144   BasicBlock* NewNode = new BasicBlock("NodeBlock");
 145   F->getBasicBlockList().insert(OrigBlock->getNext(), NewNode);
 146
 147   SetCondInst* Comp = new SetCondInst(Instruction::SetLT, Val, Pivot.first,
 148                                       "Pivot");
 149   NewNode->getInstList().push_back(Comp);
 150   new BranchInst(LBranch, RBranch, Comp, NewNode);
 151   return NewNode;
 152 }
 153
 154 // newLeafBlock - Create a new leaf block for the binary lookup tree. It
 155 // checks if the switch's value == the case's value. If not, then it
 156 // jumps to the default branch. At this point in the tree, the value
 157 // can't be another valid case value, so the jump to the "default" branch
 158 // is warranted.
 159 //
 160 BasicBlock* LowerSwitch::newLeafBlock(Case& Leaf, Value* Val,
 161                                       BasicBlock* OrigBlock,
 162                                       BasicBlock* Default)
 163 {
 164   Function* F = OrigBlock->getParent();
 165   BasicBlock* NewLeaf = new BasicBlock("LeafBlock");
 166   F->getBasicBlockList().insert(OrigBlock->getNext(), NewLeaf);
 167
 168   // Make the seteq instruction...
 169   SetCondInst* Comp = new SetCondInst(Instruction::SetEQ, Val,
 170                                       Leaf.first, "SwitchLeaf");
 171   NewLeaf->getInstList().push_back(Comp);
 172
 173   // Make the conditional branch...
 174   BasicBlock* Succ = Leaf.second;
 175   new BranchInst(Succ, Default, Comp, NewLeaf);
 176
 177   // If there were any PHI nodes in this successor, rewrite one entry
 178   // from OrigBlock to come from NewLeaf.
 179   for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
 180     PHINode* PN = cast<PHINode>(I);
 181     int BlockIdx = PN->getBasicBlockIndex(OrigBlock);
 182     assert(BlockIdx != -1 && "Switch didn't go to this successor??");
 183     PN->setIncomingBlock((unsigned)BlockIdx, NewLeaf);
 184   }
 185
 186   return NewLeaf;
 187 }
 188
 189 // processSwitchInst - Replace the specified switch instruction with a sequence
 190 // of chained if-then insts in a balanced binary search.
 191 //
 192 void LowerSwitch::processSwitchInst(SwitchInst *SI) {
 193   BasicBlock *CurBlock = SI->getParent();
 194   BasicBlock *OrigBlock = CurBlock;
 195   Function *F = CurBlock->getParent();
 196   Value *Val = SI->getOperand(0);  // The value we are switching on...
 197   BasicBlock* Default = SI->getDefaultDest();
 198
 199   // If there is only the default destination, don't bother with the code below.
 200   if (SI->getNumOperands() == 2) {
 201     new BranchInst(SI->getDefaultDest(), CurBlock);
 202     CurBlock->getInstList().erase(SI);
 203     return;
 204   }
 205
 206   // Create a new, empty default block so that the new hierarchy of
 207   // if-then statements go to this and the PHI nodes are happy.
 208   BasicBlock* NewDefault = new BasicBlock("NewDefault");
 209   F->getBasicBlockList().insert(Default, NewDefault);
 210
 211   new BranchInst(Default, NewDefault);
 212
 213   // If there is an entry in any PHI nodes for the default edge, make sure
 214   // to update them as well.
 215   for (BasicBlock::iterator I = Default->begin(); isa<PHINode>(I); ++I) {
 216     PHINode *PN = cast<PHINode>(I);
 217     int BlockIdx = PN->getBasicBlockIndex(OrigBlock);
 218     assert(BlockIdx != -1 && "Switch didn't go to this successor??");
 219     PN->setIncomingBlock((unsigned)BlockIdx, NewDefault);
 220   }
 221
 222   std::vector<Case> Cases;
 223
 224   // Expand comparisons for all of the non-default cases...
 225   for (unsigned i = 1; i < SI->getNumSuccessors(); ++i)
 226     Cases.push_back(Case(SI->getSuccessorValue(i), SI->getSuccessor(i)));
 227
 228   std::sort(Cases.begin(), Cases.end(), CaseCmp());
 229   DEBUG(std::cerr << "Cases: " << Cases << "\n");
 230   BasicBlock* SwitchBlock = switchConvert(Cases.begin(), Cases.end(), Val,
 231                                           OrigBlock, NewDefault);
 232
 233   // Branch to our shiny new if-then stuff...
 234   new BranchInst(SwitchBlock, OrigBlock);
 235
 236   // We are now done with the switch instruction, delete it.
 237   CurBlock->getInstList().erase(SI);
 238 }