-//===- ADCE.cpp - Code to perform agressive dead code elimination ---------===//
+//===- ADCE.cpp - Code to perform aggressive dead code elimination --------===//
//
-// This file implements "agressive" dead code elimination. ADCE is DCe where
+// This file implements "aggressive" dead code elimination. ADCE is DCe where
// values are assumed to be dead until proven otherwise. This is similar to
// SCCP, except applied to the liveness of values.
//
//===----------------------------------------------------------------------===//
-#include "llvm/Optimizations/DCE.h"
-#include "llvm/Instruction.h"
+#include "llvm/Transforms/Scalar.h"
+#include "llvm/Transforms/Utils/Local.h"
#include "llvm/Type.h"
#include "llvm/Analysis/Dominators.h"
#include "llvm/Analysis/Writer.h"
#include "llvm/iTerminators.h"
-#include "llvm/iOther.h"
+#include "llvm/iPHINode.h"
+#include "llvm/Support/CFG.h"
#include "Support/STLExtras.h"
#include "Support/DepthFirstIterator.h"
-#include <set>
#include <algorithm>
+#include <iostream>
+using std::cerr;
#define DEBUG_ADCE 1
+namespace {
+
//===----------------------------------------------------------------------===//
// ADCE Class
//
-// This class does all of the work of Agressive Dead Code Elimination.
+// This class does all of the work of Aggressive Dead Code Elimination.
// It's public interface consists of a constructor and a doADCE() method.
//
-class ADCE {
- Method *M; // The method that we are working on...
- vector<Instruction*> WorkList; // Instructions that just became live
- set<Instruction*> LiveSet; // The set of live instructions
+class ADCE : public FunctionPass {
+ Function *Func; // The function that we are working on
+ std::vector<Instruction*> WorkList; // Instructions that just became live
+ std::set<Instruction*> LiveSet; // The set of live instructions
bool MadeChanges;
//===--------------------------------------------------------------------===//
// The public interface for this class
//
public:
- // ADCE Ctor - Save the method to operate on...
- inline ADCE(Method *m) : M(m), MadeChanges(false) {}
+ const char *getPassName() const { return "Aggressive Dead Code Elimination"; }
+
+ // doADCE - Execute the Aggressive Dead Code Elimination Algorithm
+ //
+ virtual bool runOnFunction(Function *F) {
+ Func = F; MadeChanges = false;
+ doADCE(getAnalysis<DominanceFrontier>(DominanceFrontier::PostDomID));
+ assert(WorkList.empty());
+ LiveSet.clear();
+ return MadeChanges;
+ }
+ // getAnalysisUsage - We require post dominance frontiers (aka Control
+ // Dependence Graph)
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.addRequired(DominanceFrontier::PostDomID);
+ }
- // doADCE() - Run the Agressive Dead Code Elimination algorithm, returning
- // true if the method was modified.
- bool doADCE();
//===--------------------------------------------------------------------===//
// The implementation of this class
//
private:
+ // doADCE() - Run the Aggressive Dead Code Elimination algorithm, returning
+ // true if the function was modified.
+ //
+ void doADCE(DominanceFrontier &CDG);
+
inline void markInstructionLive(Instruction *I) {
if (LiveSet.count(I)) return;
#ifdef DEBUG_ADCE
// fixupCFG - Walk the CFG in depth first order, eliminating references to
// dead blocks.
//
- BasicBlock *fixupCFG(BasicBlock *Head, set<BasicBlock*> &VisitedBlocks,
- const set<BasicBlock*> &AliveBlocks);
+ BasicBlock *fixupCFG(BasicBlock *Head, std::set<BasicBlock*> &VisitedBlocks,
+ const std::set<BasicBlock*> &AliveBlocks);
};
+} // End of anonymous namespace
+Pass *createAggressiveDCEPass() {
+ return new ADCE();
+}
-// doADCE() - Run the Agressive Dead Code Elimination algorithm, returning
-// true if the method was modified.
-//
-bool ADCE::doADCE() {
- // Compute the control dependence graph... Note that this has a side effect
- // on the CFG: a new return bb is added and all returns are merged here.
- //
- cfg::DominanceFrontier CDG(cfg::DominatorSet(M, true));
+// doADCE() - Run the Aggressive Dead Code Elimination algorithm, returning
+// true if the function was modified.
+//
+void ADCE::doADCE(DominanceFrontier &CDG) {
#ifdef DEBUG_ADCE
- cerr << "Method: " << M;
+ cerr << "Function: " << Func;
#endif
- // Iterate over all of the instructions in the method, eliminating trivially
+ // Iterate over all of the instructions in the function, eliminating trivially
// dead instructions, and marking instructions live that are known to be
// needed. Perform the walk in depth first order so that we avoid marking any
// instructions live in basic blocks that are unreachable. These blocks will
// be eliminated later, along with the instructions inside.
//
- for (df_iterator<Method*> BBI = df_begin(M),
- BBE = df_end(M);
+ for (df_iterator<Function*> BBI = df_begin(Func), BBE = df_end(Func);
BBI != BBE; ++BBI) {
BasicBlock *BB = *BBI;
for (BasicBlock::iterator II = BB->begin(), EI = BB->end(); II != EI; ) {
if (I->hasSideEffects() || I->getOpcode() == Instruction::Ret) {
markInstructionLive(I);
+ ++II; // Increment the inst iterator if the inst wasn't deleted
+ } else if (isInstructionTriviallyDead(I)) {
+ // Remove the instruction from it's basic block...
+ delete BB->getInstList().remove(II);
+ MadeChanges = true;
} else {
- // Check to see if anything is trivially dead
- if (I->use_size() == 0 && I->getType() != Type::VoidTy) {
- // Remove the instruction from it's basic block...
- delete BB->getInstList().remove(II);
- MadeChanges = true;
- continue; // Don't increment the iterator past the current slot
- }
+ ++II; // Increment the inst iterator if the inst wasn't deleted
}
-
- ++II; // Increment the inst iterator if the inst wasn't deleted
}
}
// AliveBlocks - Set of basic blocks that we know have instructions that are
// alive in them...
//
- set<BasicBlock*> AliveBlocks;
+ std::set<BasicBlock*> AliveBlocks;
// Process the work list of instructions that just became live... if they
// became live, then that means that all of their operands are neccesary as
// this block is control dependant on as being alive also...
//
AliveBlocks.insert(BB); // Block is now ALIVE!
- cfg::DominanceFrontier::const_iterator It = CDG.find(BB);
+ DominanceFrontier::const_iterator It = CDG.find(BB);
if (It != CDG.end()) {
// Get the blocks that this node is control dependant on...
- const cfg::DominanceFrontier::DomSetType &CDB = It->second;
+ const DominanceFrontier::DomSetType &CDB = It->second;
for_each(CDB.begin(), CDB.end(), // Mark all their terminators as live
bind_obj(this, &ADCE::markTerminatorLive));
}
// Loop over all of the operands of the live instruction, making sure that
// they are known to be alive as well...
//
- for (unsigned op = 0, End = I->getNumOperands(); op != End; ++op) {
+ for (unsigned op = 0, End = I->getNumOperands(); op != End; ++op)
if (Instruction *Operand = dyn_cast<Instruction>(I->getOperand(op)))
markInstructionLive(Operand);
- }
}
#ifdef DEBUG_ADCE
- cerr << "Current Method: X = Live\n";
- for (Method::inst_iterator IL = M->inst_begin(); IL != M->inst_end(); ++IL) {
- if (LiveSet.count(*IL)) cerr << "X ";
- cerr << *IL;
- }
+ cerr << "Current Function: X = Live\n";
+ for (Function::iterator I = Func->begin(), E = Func->end(); I != E; ++I)
+ for (BasicBlock::iterator BI = (*I)->begin(), BE = (*I)->end();
+ BI != BE; ++BI) {
+ if (LiveSet.count(*BI)) cerr << "X ";
+ cerr << *BI;
+ }
#endif
// After the worklist is processed, recursively walk the CFG in depth first
// order, patching up references to dead blocks...
//
- set<BasicBlock*> VisitedBlocks;
- BasicBlock *EntryBlock = fixupCFG(M->front(), VisitedBlocks, AliveBlocks);
- if (EntryBlock && EntryBlock != M->front()) {
- if (isa<PHINode>(EntryBlock->front())) {
- // Cannot make the first block be a block with a PHI node in it! Instead,
- // strip the first basic block of the method to contain no instructions,
- // then add a simple branch to the "real" entry node...
- //
- BasicBlock *E = M->front();
- if (!isa<TerminatorInst>(E->front()) || // Check for an actual change...
- cast<TerminatorInst>(E->front())->getNumSuccessors() != 1 ||
- cast<TerminatorInst>(E->front())->getSuccessor(0) != EntryBlock) {
- E->getInstList().delete_all(); // Delete all instructions in block
- E->getInstList().push_back(new BranchInst(EntryBlock));
- MadeChanges = true;
- }
- AliveBlocks.insert(E);
-
- // Next we need to change any PHI nodes in the entry block to refer to the
- // new predecessor node...
-
-
- } else {
- // We need to move the new entry block to be the first bb of the method.
- Method::iterator EBI = find(M->begin(), M->end(), EntryBlock);
- swap(*EBI, *M->begin()); // Exchange old location with start of method
- MadeChanges = true;
- }
- }
+ std::set<BasicBlock*> VisitedBlocks;
+ BasicBlock *EntryBlock = fixupCFG(Func->front(), VisitedBlocks, AliveBlocks);
// Now go through and tell dead blocks to drop all of their references so they
- // can be safely deleted.
+ // can be safely deleted. Also, as we are doing so, if the block has
+ // successors that are still live (and that have PHI nodes in them), remove
+ // the entry for this block from the phi nodes.
//
- for (Method::iterator BI = M->begin(), BE = M->end(); BI != BE; ++BI) {
+ for (Function::iterator BI = Func->begin(), BE = Func->end(); BI != BE; ++BI){
BasicBlock *BB = *BI;
if (!AliveBlocks.count(BB)) {
+ // Remove entries from successors PHI nodes if they are still alive...
+ for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
+ if (AliveBlocks.count(*SI)) { // Only if the successor is alive...
+ BasicBlock *Succ = *SI;
+ for (BasicBlock::iterator I = Succ->begin();// Loop over all PHI nodes
+ PHINode *PN = dyn_cast<PHINode>(*I); ++I)
+ PN->removeIncomingValue(BB); // Remove value for this block
+ }
+
BB->dropAllReferences();
}
}
+ cerr << "Before Deleting Blocks: " << Func;
+
// Now loop through all of the blocks and delete them. We can safely do this
// now because we know that there are no references to dead blocks (because
// they have dropped all of their references...
//
- for (Method::iterator BI = M->begin(); BI != M->end();) {
+ for (Function::iterator BI = Func->begin(); BI != Func->end();) {
if (!AliveBlocks.count(*BI)) {
- delete M->getBasicBlocks().remove(BI);
+ delete Func->getBasicBlocks().remove(BI);
MadeChanges = true;
continue; // Don't increment iterator
}
++BI; // Increment iterator...
}
- return MadeChanges;
+ if (EntryBlock && EntryBlock != Func->front()) {
+ // We need to move the new entry block to be the first bb of the function
+ Function::iterator EBI = find(Func->begin(), Func->end(), EntryBlock);
+ std::swap(*EBI, *Func->begin()); // Exchange old location with start of fn
+ }
+
+ while (PHINode *PN = dyn_cast<PHINode>(EntryBlock->front())) {
+ assert(PN->getNumIncomingValues() == 1 &&
+ "Can only have a single incoming value at this point...");
+ // The incoming value must be outside of the scope of the function, a
+ // global variable, constant or parameter maybe...
+ //
+ PN->replaceAllUsesWith(PN->getIncomingValue(0));
+
+ // Nuke the phi node...
+ delete EntryBlock->getInstList().remove(EntryBlock->begin());
+ }
}
// been in the alive set).
// 3. Return the nonnull child, or 0 if no non-null children.
//
-BasicBlock *ADCE::fixupCFG(BasicBlock *BB, set<BasicBlock*> &VisitedBlocks,
- const set<BasicBlock*> &AliveBlocks) {
+BasicBlock *ADCE::fixupCFG(BasicBlock *BB, std::set<BasicBlock*> &VisitedBlocks,
+ const std::set<BasicBlock*> &AliveBlocks) {
if (VisitedBlocks.count(BB)) return 0; // Revisiting a node? No update.
VisitedBlocks.insert(BB); // We have now visited this node!
if (AliveBlocks.count(BB)) { // Is the block alive?
// Yes it's alive: loop through and eliminate all dead instructions in block
- for (BasicBlock::iterator II = BB->begin(); II != BB->end()-1; ) {
- Instruction *I = *II;
- if (!LiveSet.count(I)) { // Is this instruction alive?
+ for (BasicBlock::iterator II = BB->begin(); II != BB->end()-1; )
+ if (!LiveSet.count(*II)) { // Is this instruction alive?
// Nope... remove the instruction from it's basic block...
delete BB->getInstList().remove(II);
MadeChanges = true;
- continue; // Don't increment II
+ } else {
+ ++II;
}
- ++II;
- }
// Recursively traverse successors of this basic block.
- BasicBlock::succ_iterator SI = BB->succ_begin(), SE = BB->succ_end();
- for (; SI != SE; ++SI) {
+ for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI) {
BasicBlock *Succ = *SI;
BasicBlock *Repl = fixupCFG(Succ, VisitedBlocks, AliveBlocks);
if (Repl && Repl != Succ) { // We have to replace the successor
BasicBlock *ReturnBB = 0; // Default to nothing live down here
// Recursively traverse successors of this basic block.
- BasicBlock::succ_iterator SI = BB->succ_begin(), SE = BB->succ_end();
- for (; SI != SE; ++SI) {
+ for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI) {
BasicBlock *RetBB = fixupCFG(*SI, VisitedBlocks, AliveBlocks);
if (RetBB) {
- assert(ReturnBB == 0 && "One one live child allowed!");
+ assert(ReturnBB == 0 && "At most one live child allowed!");
ReturnBB = RetBB;
}
}
}
}
-
-
-// doADCE - Execute the Agressive Dead Code Elimination Algorithm
-//
-bool opt::AgressiveDCE::doADCE(Method *M) {
- if (M->isExternal()) return false;
- ADCE DCE(M);
- return DCE.doADCE();
-}
projects / oota-llvm.git / blobdiff