blob: 539dd22d47d102b54de8e61995a71e5125c91571 [file] [log] [blame]
Chris Lattner2f7c9632001-06-06 20:29:01 +00001//===- DCE.cpp - Code to perform dead code elimination --------------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner2f7c9632001-06-06 20:29:01 +00009//
Chris Lattner87e88062002-05-07 04:24:11 +000010// This file implements dead inst elimination and dead code elimination.
Chris Lattner2f7c9632001-06-06 20:29:01 +000011//
Chris Lattner87e88062002-05-07 04:24:11 +000012// Dead Inst Elimination performs a single pass over the function removing
13// instructions that are obviously dead. Dead Code Elimination is similar, but
14// it rechecks instructions that were used by removed instructions to see if
15// they are newly dead.
Chris Lattner2f7c9632001-06-06 20:29:01 +000016//
17//===----------------------------------------------------------------------===//
18
Chris Lattner79a42ac2006-12-19 21:40:18 +000019#define DEBUG_TYPE "dce"
Chris Lattnerb4cfa7f2002-05-07 20:03:00 +000020#include "llvm/Transforms/Scalar.h"
Chris Lattner560da702002-05-07 18:10:55 +000021#include "llvm/Transforms/Utils/Local.h"
22#include "llvm/Instruction.h"
Chris Lattner04805fa2002-02-26 21:46:54 +000023#include "llvm/Pass.h"
Reid Spencer557ab152007-02-05 23:32:05 +000024#include "llvm/Support/Compiler.h"
Chris Lattner87e88062002-05-07 04:24:11 +000025#include "llvm/Support/InstIterator.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000026#include "llvm/ADT/Statistic.h"
Chris Lattner87e88062002-05-07 04:24:11 +000027#include <set>
Chris Lattner49525f82004-01-09 06:02:20 +000028using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000029
Chris Lattner79a42ac2006-12-19 21:40:18 +000030STATISTIC(DIEEliminated, "Number of insts removed by DIE pass");
31STATISTIC(DCEEliminated, "Number of insts removed");
Chris Lattnerbf3a0992002-10-01 22:38:41 +000032
Chris Lattner79a42ac2006-12-19 21:40:18 +000033namespace {
Chris Lattnerbf3a0992002-10-01 22:38:41 +000034 //===--------------------------------------------------------------------===//
35 // DeadInstElimination pass implementation
36 //
Reid Spencer557ab152007-02-05 23:32:05 +000037 struct VISIBILITY_HIDDEN DeadInstElimination : public BasicBlockPass {
Nick Lewyckye7da2d62007-05-06 13:37:16 +000038 static char ID; // Pass identification, replacement for typeid
Devang Patel09f162c2007-05-01 21:15:47 +000039 DeadInstElimination() : BasicBlockPass(intptr_t(&ID)) {}
Chris Lattner113f4f42002-06-25 16:13:24 +000040 virtual bool runOnBasicBlock(BasicBlock &BB) {
Chris Lattner87e88062002-05-07 04:24:11 +000041 bool Changed = false;
Chris Lattner113f4f42002-06-25 16:13:24 +000042 for (BasicBlock::iterator DI = BB.begin(); DI != BB.end(); )
Chris Lattnerab038d42002-05-26 20:18:18 +000043 if (dceInstruction(DI)) {
Chris Lattner87e88062002-05-07 04:24:11 +000044 Changed = true;
Chris Lattner0b18c1d2002-05-10 15:38:35 +000045 ++DIEEliminated;
46 } else
Chris Lattner87e88062002-05-07 04:24:11 +000047 ++DI;
48 return Changed;
49 }
50
51 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattner820d9712002-10-21 20:00:28 +000052 AU.setPreservesCFG();
Chris Lattner87e88062002-05-07 04:24:11 +000053 }
54 };
Misha Brukmanb1c93172005-04-21 23:48:37 +000055
Devang Patel8c78a0b2007-05-03 01:11:54 +000056 char DeadInstElimination::ID = 0;
Chris Lattnerc2d3d312006-08-27 22:42:52 +000057 RegisterPass<DeadInstElimination> X("die", "Dead Instruction Elimination");
Chris Lattner2f7c9632001-06-06 20:29:01 +000058}
59
Devang Patel5292e652007-01-25 23:23:25 +000060Pass *llvm::createDeadInstEliminationPass() {
Chris Lattner04805fa2002-02-26 21:46:54 +000061 return new DeadInstElimination();
Chris Lattnerccbd4e42002-01-23 05:48:24 +000062}
63
Chris Lattner87e88062002-05-07 04:24:11 +000064
Chris Lattner04805fa2002-02-26 21:46:54 +000065namespace {
Chris Lattner79a42ac2006-12-19 21:40:18 +000066 //===--------------------------------------------------------------------===//
67 // DeadCodeElimination pass implementation
68 //
Chris Lattner87e88062002-05-07 04:24:11 +000069 struct DCE : public FunctionPass {
Nick Lewyckye7da2d62007-05-06 13:37:16 +000070 static char ID; // Pass identification, replacement for typeid
Devang Patel09f162c2007-05-01 21:15:47 +000071 DCE() : FunctionPass((intptr_t)&ID) {}
72
Chris Lattner113f4f42002-06-25 16:13:24 +000073 virtual bool runOnFunction(Function &F);
Chris Lattner87e88062002-05-07 04:24:11 +000074
75 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattner820d9712002-10-21 20:00:28 +000076 AU.setPreservesCFG();
Chris Lattner04805fa2002-02-26 21:46:54 +000077 }
Chris Lattner87e88062002-05-07 04:24:11 +000078 };
Chris Lattnerb28b6802002-07-23 18:06:35 +000079
Devang Patel8c78a0b2007-05-03 01:11:54 +000080 char DCE::ID = 0;
Chris Lattnerc2d3d312006-08-27 22:42:52 +000081 RegisterPass<DCE> Y("dce", "Dead Code Elimination");
Chris Lattner87e88062002-05-07 04:24:11 +000082}
83
Chris Lattner113f4f42002-06-25 16:13:24 +000084bool DCE::runOnFunction(Function &F) {
Chris Lattner87e88062002-05-07 04:24:11 +000085 // Start out with all of the instructions in the worklist...
Chris Lattner2d3a7a62004-04-27 15:13:33 +000086 std::vector<Instruction*> WorkList;
Chris Lattner49221182005-05-08 18:45:26 +000087 for (inst_iterator i = inst_begin(F), e = inst_end(F); i != e; ++i)
88 WorkList.push_back(&*i);
Misha Brukmanb1c93172005-04-21 23:48:37 +000089
Chris Lattner87e88062002-05-07 04:24:11 +000090 // Loop over the worklist finding instructions that are dead. If they are
91 // dead make them drop all of their uses, making other instructions
92 // potentially dead, and work until the worklist is empty.
93 //
Chris Lattner49221182005-05-08 18:45:26 +000094 bool MadeChange = false;
Chris Lattner87e88062002-05-07 04:24:11 +000095 while (!WorkList.empty()) {
96 Instruction *I = WorkList.back();
97 WorkList.pop_back();
Misha Brukmanb1c93172005-04-21 23:48:37 +000098
Chris Lattner49221182005-05-08 18:45:26 +000099 if (isInstructionTriviallyDead(I)) { // If the instruction is dead.
Chris Lattner87e88062002-05-07 04:24:11 +0000100 // Loop over all of the values that the instruction uses, if there are
101 // instructions being used, add them to the worklist, because they might
102 // go dead after this one is removed.
103 //
Chris Lattnerfb9a2992004-04-21 22:29:37 +0000104 for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI)
105 if (Instruction *Used = dyn_cast<Instruction>(*OI))
Chris Lattner87e88062002-05-07 04:24:11 +0000106 WorkList.push_back(Used);
107
Chris Lattner49221182005-05-08 18:45:26 +0000108 // Remove the instruction.
109 I->eraseFromParent();
Chris Lattner87e88062002-05-07 04:24:11 +0000110
Chris Lattner49221182005-05-08 18:45:26 +0000111 // Remove the instruction from the worklist if it still exists in it.
David Greene2a5967b2007-12-17 17:39:51 +0000112 for (std::vector<Instruction*>::iterator WI = WorkList.begin();
113 WI != WorkList.end(); ++WI)
Chris Lattner49221182005-05-08 18:45:26 +0000114 if (*WI == I) {
David Greene2a5967b2007-12-17 17:39:51 +0000115 WI = WorkList.erase(WI);
Chris Lattner49221182005-05-08 18:45:26 +0000116 --WI;
117 }
118
119 MadeChange = true;
120 ++DCEEliminated;
Chris Lattner04805fa2002-02-26 21:46:54 +0000121 }
Chris Lattner87e88062002-05-07 04:24:11 +0000122 }
Chris Lattner49221182005-05-08 18:45:26 +0000123 return MadeChange;
Chris Lattner04805fa2002-02-26 21:46:54 +0000124}
125
Brian Gaeke38b79e82004-07-27 17:43:21 +0000126FunctionPass *llvm::createDeadCodeEliminationPass() {
Chris Lattner87e88062002-05-07 04:24:11 +0000127 return new DCE();
Chris Lattner04805fa2002-02-26 21:46:54 +0000128}
Brian Gaeke960707c2003-11-11 22:41:34 +0000129