blob: 664c3f6a222f7df19f6ddd74bb03da8780059abf [file] [log] [blame]
Misha Brukman82c89b92003-05-20 21:01:22 +00001//===- ConstantProp.cpp - Code to perform Simple Constant Propagation -----===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-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 Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner00950542001-06-06 20:29:01 +00009//
Misha Brukman82c89b92003-05-20 21:01:22 +000010// This file implements constant propagation and merging:
Chris Lattner00950542001-06-06 20:29:01 +000011//
12// Specifically, this:
Chris Lattner89df1b52002-05-06 18:21:31 +000013// * Converts instructions like "add int 1, 2" into 3
Chris Lattner00950542001-06-06 20:29:01 +000014//
15// Notice that:
16// * This pass has a habit of making definitions be dead. It is a good idea
Duncan Sands58921fe2008-08-01 12:23:49 +000017// to run a DIE pass sometime after running this pass.
Chris Lattner00950542001-06-06 20:29:01 +000018//
19//===----------------------------------------------------------------------===//
20
Chris Lattner0e5f4992006-12-19 21:40:18 +000021#define DEBUG_TYPE "constprop"
Chris Lattner022103b2002-05-07 20:03:00 +000022#include "llvm/Transforms/Scalar.h"
Chris Lattner79066fa2007-01-30 23:46:24 +000023#include "llvm/Analysis/ConstantFolding.h"
Chris Lattnerb6ac8bc2004-01-12 19:15:20 +000024#include "llvm/Constant.h"
Chris Lattner2ed01d82002-05-07 18:10:55 +000025#include "llvm/Instruction.h"
Chris Lattnerbd0ef772002-02-26 21:46:54 +000026#include "llvm/Pass.h"
Chris Lattner89df1b52002-05-06 18:21:31 +000027#include "llvm/Support/InstIterator.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000028#include "llvm/ADT/Statistic.h"
Chris Lattner89df1b52002-05-06 18:21:31 +000029#include <set>
Chris Lattnerd7456022004-01-09 06:02:20 +000030using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000031
Chris Lattner0e5f4992006-12-19 21:40:18 +000032STATISTIC(NumInstKilled, "Number of instructions killed");
Chris Lattnera92f6962002-10-01 22:38:41 +000033
Chris Lattner0e5f4992006-12-19 21:40:18 +000034namespace {
Chris Lattner3e8b6632009-09-02 06:11:42 +000035 struct ConstantPropagation : public FunctionPass {
Nick Lewyckyecd94c82007-05-06 13:37:16 +000036 static char ID; // Pass identification, replacement for typeid
Owen Anderson081c34b2010-10-19 17:21:58 +000037 ConstantPropagation() : FunctionPass(ID) {
38 initializeConstantPropagationPass(*PassRegistry::getPassRegistry());
39 }
Devang Patel794fd752007-05-01 21:15:47 +000040
Chris Lattner7e708292002-06-25 16:13:24 +000041 bool runOnFunction(Function &F);
Chris Lattner97e52e42002-04-28 21:27:06 +000042
43 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattnercb2610e2002-10-21 20:00:28 +000044 AU.setPreservesCFG();
Chris Lattner97e52e42002-04-28 21:27:06 +000045 }
Chris Lattnerbd0ef772002-02-26 21:46:54 +000046 };
Chris Lattner00950542001-06-06 20:29:01 +000047}
Chris Lattnerbd0ef772002-02-26 21:46:54 +000048
Dan Gohman844731a2008-05-13 00:00:25 +000049char ConstantPropagation::ID = 0;
Owen Andersond13db2c2010-07-21 22:09:45 +000050INITIALIZE_PASS(ConstantPropagation, "constprop",
Owen Andersonce665bd2010-10-07 22:25:06 +000051 "Simple constant propagation", false, false)
Dan Gohman844731a2008-05-13 00:00:25 +000052
Chris Lattner4b501562004-09-20 04:43:15 +000053FunctionPass *llvm::createConstantPropagationPass() {
Misha Brukman82c89b92003-05-20 21:01:22 +000054 return new ConstantPropagation();
Chris Lattnerbd0ef772002-02-26 21:46:54 +000055}
56
Chris Lattner89df1b52002-05-06 18:21:31 +000057
Misha Brukman82c89b92003-05-20 21:01:22 +000058bool ConstantPropagation::runOnFunction(Function &F) {
Chris Lattner89df1b52002-05-06 18:21:31 +000059 // Initialize the worklist to all of the instructions ready to process...
Chris Lattner6ffe5512004-04-27 15:13:33 +000060 std::set<Instruction*> WorkList;
61 for(inst_iterator i = inst_begin(F), e = inst_end(F); i != e; ++i) {
62 WorkList.insert(&*i);
63 }
Chris Lattner89df1b52002-05-06 18:21:31 +000064 bool Changed = false;
65
66 while (!WorkList.empty()) {
67 Instruction *I = *WorkList.begin();
68 WorkList.erase(WorkList.begin()); // Get an element from the worklist...
69
70 if (!I->use_empty()) // Don't muck with dead instructions...
Chris Lattner7b550cc2009-11-06 04:27:31 +000071 if (Constant *C = ConstantFoldInstruction(I)) {
Chris Lattner89df1b52002-05-06 18:21:31 +000072 // Add all of the users of this instruction to the worklist, they might
Misha Brukman82c89b92003-05-20 21:01:22 +000073 // be constant propagatable now...
Chris Lattner89df1b52002-05-06 18:21:31 +000074 for (Value::use_iterator UI = I->use_begin(), UE = I->use_end();
75 UI != UE; ++UI)
76 WorkList.insert(cast<Instruction>(*UI));
Misha Brukmanfd939082005-04-21 23:48:37 +000077
Chris Lattner89df1b52002-05-06 18:21:31 +000078 // Replace all of the uses of a variable with uses of the constant.
79 I->replaceAllUsesWith(C);
Chris Lattner3dec1f22002-05-10 15:38:35 +000080
Chris Lattner4647b7c2004-04-13 19:28:20 +000081 // Remove the dead instruction.
82 WorkList.erase(I);
Dan Gohman1adec832008-06-21 22:08:46 +000083 I->eraseFromParent();
Chris Lattner4647b7c2004-04-13 19:28:20 +000084
Chris Lattner89df1b52002-05-06 18:21:31 +000085 // We made a change to the function...
86 Changed = true;
Chris Lattner3dec1f22002-05-10 15:38:35 +000087 ++NumInstKilled;
Chris Lattner89df1b52002-05-06 18:21:31 +000088 }
89 }
90 return Changed;
91}