2003-04-23 16:23:59 +00:00
|
|
|
//===- LowerSwitch.cpp - Eliminate Switch instructions --------------------===//
|
2005-04-21 23:48:37 +00:00
|
|
|
//
|
2003-10-20 19:43:21 +00:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file was developed by the LLVM research group and is distributed under
|
|
|
|
// the University of Illinois Open Source License. See LICENSE.TXT for details.
|
2005-04-21 23:48:37 +00:00
|
|
|
//
|
2003-10-20 19:43:21 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2003-04-23 16:23:59 +00:00
|
|
|
//
|
|
|
|
// The LowerSwitch transformation rewrites switch statements with a sequence of
|
|
|
|
// branches, which allows targets to get away with not implementing the switch
|
|
|
|
// statement until it is convenient.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#include "llvm/Transforms/Scalar.h"
|
2006-05-09 04:13:41 +00:00
|
|
|
#include "llvm/Transforms/Utils/UnifyFunctionExitNodes.h"
|
2003-10-07 18:46:23 +00:00
|
|
|
#include "llvm/Constants.h"
|
2003-04-23 16:23:59 +00:00
|
|
|
#include "llvm/Function.h"
|
2004-07-29 17:05:13 +00:00
|
|
|
#include "llvm/Instructions.h"
|
2003-04-23 16:23:59 +00:00
|
|
|
#include "llvm/Pass.h"
|
2004-09-01 22:55:40 +00:00
|
|
|
#include "llvm/Support/Debug.h"
|
2006-08-27 12:54:02 +00:00
|
|
|
#include "llvm/Support/Compiler.h"
|
2004-09-01 22:55:40 +00:00
|
|
|
#include "llvm/ADT/Statistic.h"
|
2004-09-03 18:19:51 +00:00
|
|
|
#include <algorithm>
|
2004-01-09 06:02:20 +00:00
|
|
|
using namespace llvm;
|
2003-11-11 22:41:34 +00:00
|
|
|
|
2003-04-23 16:23:59 +00:00
|
|
|
namespace {
|
2006-12-06 17:46:33 +00:00
|
|
|
Statistic NumLowered("lowerswitch", "Number of SwitchInst's replaced");
|
2003-04-23 16:23:59 +00:00
|
|
|
|
|
|
|
/// LowerSwitch Pass - Replace all SwitchInst instructions with chained branch
|
|
|
|
/// instructions. Note that this cannot be a BasicBlock pass because it
|
|
|
|
/// modifies the CFG!
|
2006-06-28 22:08:15 +00:00
|
|
|
class VISIBILITY_HIDDEN LowerSwitch : public FunctionPass {
|
2003-10-07 18:46:23 +00:00
|
|
|
public:
|
2006-05-09 04:13:41 +00:00
|
|
|
virtual bool runOnFunction(Function &F);
|
2006-05-17 21:05:27 +00:00
|
|
|
|
2006-05-09 04:13:41 +00:00
|
|
|
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
|
2006-05-17 21:05:27 +00:00
|
|
|
// This is a cluster of orthogonal Transforms
|
2006-05-09 04:13:41 +00:00
|
|
|
AU.addPreserved<UnifyFunctionExitNodes>();
|
|
|
|
AU.addPreservedID(PromoteMemoryToRegisterID);
|
|
|
|
AU.addPreservedID(LowerSelectID);
|
2006-05-17 21:05:27 +00:00
|
|
|
AU.addPreservedID(LowerInvokePassID);
|
|
|
|
AU.addPreservedID(LowerAllocationsID);
|
2006-05-09 04:13:41 +00:00
|
|
|
}
|
2006-05-17 21:05:27 +00:00
|
|
|
|
2003-10-07 18:46:23 +00:00
|
|
|
typedef std::pair<Constant*, BasicBlock*> Case;
|
|
|
|
typedef std::vector<Case>::iterator CaseItr;
|
|
|
|
private:
|
2003-04-23 16:23:59 +00:00
|
|
|
void processSwitchInst(SwitchInst *SI);
|
2003-10-07 18:46:23 +00:00
|
|
|
|
|
|
|
BasicBlock* switchConvert(CaseItr Begin, CaseItr End, Value* Val,
|
|
|
|
BasicBlock* OrigBlock, BasicBlock* Default);
|
|
|
|
BasicBlock* newLeafBlock(Case& Leaf, Value* Val,
|
|
|
|
BasicBlock* OrigBlock, BasicBlock* Default);
|
|
|
|
};
|
|
|
|
|
|
|
|
/// The comparison function for sorting the switch case values in the vector.
|
|
|
|
struct CaseCmp {
|
|
|
|
bool operator () (const LowerSwitch::Case& C1,
|
|
|
|
const LowerSwitch::Case& C2) {
|
|
|
|
|
2006-10-20 07:07:24 +00:00
|
|
|
const ConstantInt* CI1 = cast<const ConstantInt>(C1.first);
|
|
|
|
const ConstantInt* CI2 = cast<const ConstantInt>(C2.first);
|
|
|
|
if (CI1->getType()->isUnsigned())
|
|
|
|
return CI1->getZExtValue() < CI2->getZExtValue();
|
|
|
|
return CI1->getSExtValue() < CI2->getSExtValue();
|
2003-10-07 18:46:23 +00:00
|
|
|
}
|
2003-04-23 16:23:59 +00:00
|
|
|
};
|
|
|
|
|
2006-08-27 22:42:52 +00:00
|
|
|
RegisterPass<LowerSwitch>
|
2003-04-23 16:23:59 +00:00
|
|
|
X("lowerswitch", "Lower SwitchInst's to branches");
|
|
|
|
}
|
|
|
|
|
2006-05-02 04:24:36 +00:00
|
|
|
// Publically exposed interface to pass...
|
|
|
|
const PassInfo *llvm::LowerSwitchID = X.getPassInfo();
|
2003-04-23 16:23:59 +00:00
|
|
|
// createLowerSwitchPass - Interface to this file...
|
2004-01-09 06:02:20 +00:00
|
|
|
FunctionPass *llvm::createLowerSwitchPass() {
|
2003-04-23 16:23:59 +00:00
|
|
|
return new LowerSwitch();
|
|
|
|
}
|
|
|
|
|
|
|
|
bool LowerSwitch::runOnFunction(Function &F) {
|
|
|
|
bool Changed = false;
|
|
|
|
|
|
|
|
for (Function::iterator I = F.begin(), E = F.end(); I != E; ) {
|
|
|
|
BasicBlock *Cur = I++; // Advance over block so we don't traverse new blocks
|
|
|
|
|
|
|
|
if (SwitchInst *SI = dyn_cast<SwitchInst>(Cur->getTerminator())) {
|
|
|
|
Changed = true;
|
|
|
|
processSwitchInst(SI);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return Changed;
|
|
|
|
}
|
|
|
|
|
2003-10-07 18:46:23 +00:00
|
|
|
// operator<< - Used for debugging purposes.
|
|
|
|
//
|
2006-12-07 01:30:32 +00:00
|
|
|
OStream& operator<<(OStream &O, const std::vector<LowerSwitch::Case> &C) {
|
2003-10-07 18:46:23 +00:00
|
|
|
O << "[";
|
|
|
|
|
2004-01-09 06:02:20 +00:00
|
|
|
for (std::vector<LowerSwitch::Case>::const_iterator B = C.begin(),
|
|
|
|
E = C.end(); B != E; ) {
|
2003-10-07 18:46:23 +00:00
|
|
|
O << *B->first;
|
|
|
|
if (++B != E) O << ", ";
|
|
|
|
}
|
|
|
|
|
|
|
|
return O << "]";
|
|
|
|
}
|
|
|
|
|
|
|
|
// switchConvert - Convert the switch statement into a binary lookup of
|
|
|
|
// the case values. The function recursively builds this tree.
|
|
|
|
//
|
|
|
|
BasicBlock* LowerSwitch::switchConvert(CaseItr Begin, CaseItr End,
|
|
|
|
Value* Val, BasicBlock* OrigBlock,
|
|
|
|
BasicBlock* Default)
|
|
|
|
{
|
|
|
|
unsigned Size = End - Begin;
|
|
|
|
|
|
|
|
if (Size == 1)
|
|
|
|
return newLeafBlock(*Begin, Val, OrigBlock, Default);
|
|
|
|
|
|
|
|
unsigned Mid = Size / 2;
|
|
|
|
std::vector<Case> LHS(Begin, Begin + Mid);
|
2006-11-26 10:17:54 +00:00
|
|
|
DOUT << "LHS: " << LHS << "\n";
|
2003-10-07 18:46:23 +00:00
|
|
|
std::vector<Case> RHS(Begin + Mid, End);
|
2006-11-26 10:17:54 +00:00
|
|
|
DOUT << "RHS: " << RHS << "\n";
|
2003-10-07 18:46:23 +00:00
|
|
|
|
|
|
|
Case& Pivot = *(Begin + Mid);
|
2006-11-26 10:17:54 +00:00
|
|
|
DOUT << "Pivot ==> "
|
|
|
|
<< cast<ConstantInt>(Pivot.first)->getSExtValue() << "\n";
|
2003-10-07 18:46:23 +00:00
|
|
|
|
|
|
|
BasicBlock* LBranch = switchConvert(LHS.begin(), LHS.end(), Val,
|
|
|
|
OrigBlock, Default);
|
|
|
|
BasicBlock* RBranch = switchConvert(RHS.begin(), RHS.end(), Val,
|
|
|
|
OrigBlock, Default);
|
|
|
|
|
|
|
|
// Create a new node that checks if the value is < pivot. Go to the
|
|
|
|
// left branch if it is and right branch if not.
|
|
|
|
Function* F = OrigBlock->getParent();
|
|
|
|
BasicBlock* NewNode = new BasicBlock("NodeBlock");
|
|
|
|
F->getBasicBlockList().insert(OrigBlock->getNext(), NewNode);
|
|
|
|
|
|
|
|
SetCondInst* Comp = new SetCondInst(Instruction::SetLT, Val, Pivot.first,
|
|
|
|
"Pivot");
|
|
|
|
NewNode->getInstList().push_back(Comp);
|
2003-11-20 18:25:24 +00:00
|
|
|
new BranchInst(LBranch, RBranch, Comp, NewNode);
|
2003-10-07 18:46:23 +00:00
|
|
|
return NewNode;
|
|
|
|
}
|
|
|
|
|
|
|
|
// newLeafBlock - Create a new leaf block for the binary lookup tree. It
|
|
|
|
// checks if the switch's value == the case's value. If not, then it
|
|
|
|
// jumps to the default branch. At this point in the tree, the value
|
|
|
|
// can't be another valid case value, so the jump to the "default" branch
|
|
|
|
// is warranted.
|
|
|
|
//
|
|
|
|
BasicBlock* LowerSwitch::newLeafBlock(Case& Leaf, Value* Val,
|
|
|
|
BasicBlock* OrigBlock,
|
|
|
|
BasicBlock* Default)
|
|
|
|
{
|
|
|
|
Function* F = OrigBlock->getParent();
|
|
|
|
BasicBlock* NewLeaf = new BasicBlock("LeafBlock");
|
|
|
|
F->getBasicBlockList().insert(OrigBlock->getNext(), NewLeaf);
|
|
|
|
|
|
|
|
// Make the seteq instruction...
|
|
|
|
SetCondInst* Comp = new SetCondInst(Instruction::SetEQ, Val,
|
|
|
|
Leaf.first, "SwitchLeaf");
|
|
|
|
NewLeaf->getInstList().push_back(Comp);
|
|
|
|
|
|
|
|
// Make the conditional branch...
|
|
|
|
BasicBlock* Succ = Leaf.second;
|
2003-11-20 18:25:24 +00:00
|
|
|
new BranchInst(Succ, Default, Comp, NewLeaf);
|
2003-10-07 18:46:23 +00:00
|
|
|
|
|
|
|
// If there were any PHI nodes in this successor, rewrite one entry
|
|
|
|
// from OrigBlock to come from NewLeaf.
|
2004-09-15 17:06:42 +00:00
|
|
|
for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
|
|
|
|
PHINode* PN = cast<PHINode>(I);
|
2003-10-07 18:46:23 +00:00
|
|
|
int BlockIdx = PN->getBasicBlockIndex(OrigBlock);
|
|
|
|
assert(BlockIdx != -1 && "Switch didn't go to this successor??");
|
|
|
|
PN->setIncomingBlock((unsigned)BlockIdx, NewLeaf);
|
|
|
|
}
|
|
|
|
|
|
|
|
return NewLeaf;
|
|
|
|
}
|
|
|
|
|
2003-04-23 16:23:59 +00:00
|
|
|
// processSwitchInst - Replace the specified switch instruction with a sequence
|
2003-10-07 18:46:23 +00:00
|
|
|
// of chained if-then insts in a balanced binary search.
|
2003-04-23 16:23:59 +00:00
|
|
|
//
|
|
|
|
void LowerSwitch::processSwitchInst(SwitchInst *SI) {
|
|
|
|
BasicBlock *CurBlock = SI->getParent();
|
|
|
|
BasicBlock *OrigBlock = CurBlock;
|
|
|
|
Function *F = CurBlock->getParent();
|
|
|
|
Value *Val = SI->getOperand(0); // The value we are switching on...
|
2003-10-07 18:46:23 +00:00
|
|
|
BasicBlock* Default = SI->getDefaultDest();
|
2003-04-23 16:23:59 +00:00
|
|
|
|
2003-08-23 22:54:34 +00:00
|
|
|
// If there is only the default destination, don't bother with the code below.
|
|
|
|
if (SI->getNumOperands() == 2) {
|
2003-11-21 16:52:05 +00:00
|
|
|
new BranchInst(SI->getDefaultDest(), CurBlock);
|
2004-03-14 04:14:31 +00:00
|
|
|
CurBlock->getInstList().erase(SI);
|
2003-08-23 22:54:34 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2003-10-07 18:46:23 +00:00
|
|
|
// Create a new, empty default block so that the new hierarchy of
|
|
|
|
// if-then statements go to this and the PHI nodes are happy.
|
|
|
|
BasicBlock* NewDefault = new BasicBlock("NewDefault");
|
|
|
|
F->getBasicBlockList().insert(Default, NewDefault);
|
2003-04-23 16:23:59 +00:00
|
|
|
|
2003-11-21 16:52:05 +00:00
|
|
|
new BranchInst(Default, NewDefault);
|
2003-05-01 22:21:21 +00:00
|
|
|
|
2003-10-07 18:46:23 +00:00
|
|
|
// If there is an entry in any PHI nodes for the default edge, make sure
|
|
|
|
// to update them as well.
|
2004-09-15 17:06:42 +00:00
|
|
|
for (BasicBlock::iterator I = Default->begin(); isa<PHINode>(I); ++I) {
|
|
|
|
PHINode *PN = cast<PHINode>(I);
|
2003-10-07 18:46:23 +00:00
|
|
|
int BlockIdx = PN->getBasicBlockIndex(OrigBlock);
|
|
|
|
assert(BlockIdx != -1 && "Switch didn't go to this successor??");
|
|
|
|
PN->setIncomingBlock((unsigned)BlockIdx, NewDefault);
|
2003-04-23 16:23:59 +00:00
|
|
|
}
|
|
|
|
|
2003-10-07 18:46:23 +00:00
|
|
|
std::vector<Case> Cases;
|
|
|
|
|
|
|
|
// Expand comparisons for all of the non-default cases...
|
|
|
|
for (unsigned i = 1; i < SI->getNumSuccessors(); ++i)
|
|
|
|
Cases.push_back(Case(SI->getSuccessorValue(i), SI->getSuccessor(i)));
|
|
|
|
|
|
|
|
std::sort(Cases.begin(), Cases.end(), CaseCmp());
|
2006-11-26 10:17:54 +00:00
|
|
|
DOUT << "Cases: " << Cases << "\n";
|
2003-10-07 18:46:23 +00:00
|
|
|
BasicBlock* SwitchBlock = switchConvert(Cases.begin(), Cases.end(), Val,
|
|
|
|
OrigBlock, NewDefault);
|
|
|
|
|
|
|
|
// Branch to our shiny new if-then stuff...
|
2003-11-21 16:52:05 +00:00
|
|
|
new BranchInst(SwitchBlock, OrigBlock);
|
2003-10-07 18:46:23 +00:00
|
|
|
|
2003-04-23 16:23:59 +00:00
|
|
|
// We are now done with the switch instruction, delete it.
|
2004-03-14 04:14:31 +00:00
|
|
|
CurBlock->getInstList().erase(SI);
|
2003-04-23 16:23:59 +00:00
|
|
|
}
|