1 //===- SCCP.cpp - Sparse Conditional Constant Propogation -----------------===//
3 // This file implements sparse conditional constant propogation and merging:
6 // * Assumes values are constant unless proven otherwise
7 // * Assumes BasicBlocks are dead unless proven otherwise
8 // * Proves values to be constant, and replaces them with constants
9 // * Proves conditional branches to be unconditional
12 // * This pass has a habit of making definitions be dead. It is a good idea
13 // to to run a DCE pass sometime after running this pass.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/Transforms/Scalar.h"
18 #include "llvm/ConstantHandling.h"
19 #include "llvm/Function.h"
20 #include "llvm/Instructions.h"
21 #include "llvm/Pass.h"
22 #include "llvm/Support/InstVisitor.h"
23 #include "Support/STLExtras.h"
24 #include "Support/Statistic.h"
28 // InstVal class - This class represents the different lattice values that an
29 // instruction may occupy. It is a simple class with value semantics.
32 Statistic<> NumInstRemoved("sccp", "Number of instructions removed");
36 undefined, // This instruction has no known value
37 constant, // This instruction has a constant value
38 overdefined // This instruction has an unknown value
39 } LatticeValue; // The current lattice position
40 Constant *ConstantVal; // If Constant value, the current value
42 inline InstVal() : LatticeValue(undefined), ConstantVal(0) {}
44 // markOverdefined - Return true if this is a new status to be in...
45 inline bool markOverdefined() {
46 if (LatticeValue != overdefined) {
47 LatticeValue = overdefined;
53 // markConstant - Return true if this is a new status for us...
54 inline bool markConstant(Constant *V) {
55 if (LatticeValue != constant) {
56 LatticeValue = constant;
60 assert(ConstantVal == V && "Marking constant with different value");
65 inline bool isUndefined() const { return LatticeValue == undefined; }
66 inline bool isConstant() const { return LatticeValue == constant; }
67 inline bool isOverdefined() const { return LatticeValue == overdefined; }
69 inline Constant *getConstant() const { return ConstantVal; }
72 } // end anonymous namespace
75 //===----------------------------------------------------------------------===//
78 // This class does all of the work of Sparse Conditional Constant Propogation.
81 class SCCP : public FunctionPass, public InstVisitor<SCCP> {
82 std::set<BasicBlock*> BBExecutable;// The basic blocks that are executable
83 std::map<Value*, InstVal> ValueState; // The state each value is in...
85 std::vector<Instruction*> InstWorkList;// The instruction work list
86 std::vector<BasicBlock*> BBWorkList; // The BasicBlock work list
89 // runOnFunction - Run the Sparse Conditional Constant Propogation algorithm,
90 // and return true if the function was modified.
92 bool runOnFunction(Function &F);
94 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
99 //===--------------------------------------------------------------------===//
100 // The implementation of this class
103 friend class InstVisitor<SCCP>; // Allow callbacks from visitor
105 // markValueOverdefined - Make a value be marked as "constant". If the value
106 // is not already a constant, add it to the instruction work list so that
107 // the users of the instruction are updated later.
109 inline bool markConstant(Instruction *I, Constant *V) {
110 if (ValueState[I].markConstant(V)) {
111 DEBUG(std::cerr << "markConstant: " << V << " = " << I);
112 InstWorkList.push_back(I);
118 // markValueOverdefined - Make a value be marked as "overdefined". If the
119 // value is not already overdefined, add it to the instruction work list so
120 // that the users of the instruction are updated later.
122 inline bool markOverdefined(Value *V) {
123 if (ValueState[V].markOverdefined()) {
124 if (Instruction *I = dyn_cast<Instruction>(V)) {
125 DEBUG(std::cerr << "markOverdefined: " << V);
126 InstWorkList.push_back(I); // Only instructions go on the work list
133 // getValueState - Return the InstVal object that corresponds to the value.
134 // This function is neccesary because not all values should start out in the
135 // underdefined state... Argument's should be overdefined, and
136 // constants should be marked as constants. If a value is not known to be an
137 // Instruction object, then use this accessor to get its value from the map.
139 inline InstVal &getValueState(Value *V) {
140 std::map<Value*, InstVal>::iterator I = ValueState.find(V);
141 if (I != ValueState.end()) return I->second; // Common case, in the map
143 if (Constant *CPV = dyn_cast<Constant>(V)) { // Constants are constant
144 ValueState[CPV].markConstant(CPV);
145 } else if (isa<Argument>(V)) { // Arguments are overdefined
146 ValueState[V].markOverdefined();
147 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
148 // The address of a global is a constant...
149 ValueState[V].markConstant(ConstantPointerRef::get(GV));
151 // All others are underdefined by default...
152 return ValueState[V];
155 // markExecutable - Mark a basic block as executable, adding it to the BB
156 // work list if it is not already executable...
158 void markExecutable(BasicBlock *BB) {
159 if (BBExecutable.count(BB)) {
160 // BB is already executable, but we may have just made an edge feasible
161 // that wasn't before. Add the PHI nodes to the work list so that they
163 for (BasicBlock::iterator I = BB->begin();
164 PHINode *PN = dyn_cast<PHINode>(I); ++I)
165 InstWorkList.push_back(PN);
168 DEBUG(std::cerr << "Marking BB Executable: " << *BB);
169 BBExecutable.insert(BB); // Basic block is executable!
170 BBWorkList.push_back(BB); // Add the block to the work list!
175 // visit implementations - Something changed in this instruction... Either an
176 // operand made a transition, or the instruction is newly executable. Change
177 // the value type of I to reflect these changes if appropriate.
179 void visitPHINode(PHINode &I);
182 void visitReturnInst(ReturnInst &I) { /*does not have an effect*/ }
183 void visitTerminatorInst(TerminatorInst &TI);
185 void visitCastInst(CastInst &I);
186 void visitBinaryOperator(Instruction &I);
187 void visitShiftInst(ShiftInst &I) { visitBinaryOperator(I); }
189 // Instructions that cannot be folded away...
190 void visitStoreInst (Instruction &I) { /*returns void*/ }
191 void visitLoadInst (Instruction &I) { markOverdefined(&I); }
192 void visitGetElementPtrInst(GetElementPtrInst &I);
193 void visitCallInst (Instruction &I) { markOverdefined(&I); }
194 void visitInvokeInst (Instruction &I) { markOverdefined(&I); }
195 void visitAllocationInst(Instruction &I) { markOverdefined(&I); }
196 void visitFreeInst (Instruction &I) { /*returns void*/ }
198 void visitInstruction(Instruction &I) {
199 // If a new instruction is added to LLVM that we don't handle...
200 std::cerr << "SCCP: Don't know how to handle: " << I;
201 markOverdefined(&I); // Just in case
204 // getFeasibleSuccessors - Return a vector of booleans to indicate which
205 // successors are reachable from a given terminator instruction.
207 void getFeasibleSuccessors(TerminatorInst &TI, std::vector<bool> &Succs);
209 // isEdgeFeasible - Return true if the control flow edge from the 'From' basic
210 // block to the 'To' basic block is currently feasible...
212 bool isEdgeFeasible(BasicBlock *From, BasicBlock *To);
214 // OperandChangedState - This method is invoked on all of the users of an
215 // instruction that was just changed state somehow.... Based on this
216 // information, we need to update the specified user of this instruction.
218 void OperandChangedState(User *U) {
219 // Only instructions use other variable values!
220 Instruction &I = cast<Instruction>(*U);
221 if (BBExecutable.count(I.getParent())) // Inst is executable?
226 RegisterOpt<SCCP> X("sccp", "Sparse Conditional Constant Propagation");
227 } // end anonymous namespace
230 // createSCCPPass - This is the public interface to this file...
232 Pass *createSCCPPass() {
237 //===----------------------------------------------------------------------===//
238 // SCCP Class Implementation
241 // runOnFunction() - Run the Sparse Conditional Constant Propogation algorithm,
242 // and return true if the function was modified.
244 bool SCCP::runOnFunction(Function &F) {
245 // Mark the first block of the function as being executable...
246 markExecutable(&F.front());
248 // Process the work lists until their are empty!
249 while (!BBWorkList.empty() || !InstWorkList.empty()) {
250 // Process the instruction work list...
251 while (!InstWorkList.empty()) {
252 Instruction *I = InstWorkList.back();
253 InstWorkList.pop_back();
255 DEBUG(std::cerr << "\nPopped off I-WL: " << I);
257 // "I" got into the work list because it either made the transition from
258 // bottom to constant, or to Overdefined.
260 // Update all of the users of this instruction's value...
262 for_each(I->use_begin(), I->use_end(),
263 bind_obj(this, &SCCP::OperandChangedState));
266 // Process the basic block work list...
267 while (!BBWorkList.empty()) {
268 BasicBlock *BB = BBWorkList.back();
269 BBWorkList.pop_back();
271 DEBUG(std::cerr << "\nPopped off BBWL: " << BB);
273 // Notify all instructions in this basic block that they are newly
280 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
281 if (!BBExecutable.count(I))
282 std::cerr << "BasicBlock Dead:" << *I;
285 // Iterate over all of the instructions in a function, replacing them with
286 // constants if we have found them to be of constant values.
288 bool MadeChanges = false;
289 for (Function::iterator BB = F.begin(), BBE = F.end(); BB != BBE; ++BB)
290 for (BasicBlock::iterator BI = BB->begin(); BI != BB->end();) {
291 Instruction &Inst = *BI;
292 InstVal &IV = ValueState[&Inst];
293 if (IV.isConstant()) {
294 Constant *Const = IV.getConstant();
295 DEBUG(std::cerr << "Constant: " << Const << " = " << Inst);
297 // Replaces all of the uses of a variable with uses of the constant.
298 Inst.replaceAllUsesWith(Const);
300 // Remove the operator from the list of definitions... and delete it.
301 BI = BB->getInstList().erase(BI);
303 // Hey, we just changed something!
311 // Reset state so that the next invocation will have empty data structures
312 BBExecutable.clear();
314 std::vector<Instruction*>().swap(InstWorkList);
315 std::vector<BasicBlock*>().swap(BBWorkList);
321 // getFeasibleSuccessors - Return a vector of booleans to indicate which
322 // successors are reachable from a given terminator instruction.
324 void SCCP::getFeasibleSuccessors(TerminatorInst &TI, std::vector<bool> &Succs) {
325 Succs.resize(TI.getNumSuccessors());
326 if (BranchInst *BI = dyn_cast<BranchInst>(&TI)) {
327 if (BI->isUnconditional()) {
330 InstVal &BCValue = getValueState(BI->getCondition());
331 if (BCValue.isOverdefined()) {
332 // Overdefined condition variables mean the branch could go either way.
333 Succs[0] = Succs[1] = true;
334 } else if (BCValue.isConstant()) {
335 // Constant condition variables mean the branch can only go a single way
336 Succs[BCValue.getConstant() == ConstantBool::False] = true;
339 } else if (InvokeInst *II = dyn_cast<InvokeInst>(&TI)) {
340 // Invoke instructions successors are always executable.
341 Succs[0] = Succs[1] = true;
342 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(&TI)) {
343 InstVal &SCValue = getValueState(SI->getCondition());
344 if (SCValue.isOverdefined()) { // Overdefined condition?
345 // All destinations are executable!
346 Succs.assign(TI.getNumSuccessors(), true);
347 } else if (SCValue.isConstant()) {
348 Constant *CPV = SCValue.getConstant();
349 // Make sure to skip the "default value" which isn't a value
350 for (unsigned i = 1, E = SI->getNumSuccessors(); i != E; ++i) {
351 if (SI->getSuccessorValue(i) == CPV) {// Found the right branch...
357 // Constant value not equal to any of the branches... must execute
358 // default branch then...
362 std::cerr << "SCCP: Don't know how to handle: " << TI;
363 Succs.assign(TI.getNumSuccessors(), true);
368 // isEdgeFeasible - Return true if the control flow edge from the 'From' basic
369 // block to the 'To' basic block is currently feasible...
371 bool SCCP::isEdgeFeasible(BasicBlock *From, BasicBlock *To) {
372 assert(BBExecutable.count(To) && "Dest should always be alive!");
374 // Make sure the source basic block is executable!!
375 if (!BBExecutable.count(From)) return false;
377 // Check to make sure this edge itself is actually feasible now...
378 TerminatorInst *FT = From->getTerminator();
379 std::vector<bool> SuccFeasible;
380 getFeasibleSuccessors(*FT, SuccFeasible);
382 // Check all edges from From to To. If any are feasible, return true.
383 for (unsigned i = 0, e = SuccFeasible.size(); i != e; ++i)
384 if (FT->getSuccessor(i) == To && SuccFeasible[i])
387 // Otherwise, none of the edges are actually feasible at this time...
391 // visit Implementations - Something changed in this instruction... Either an
392 // operand made a transition, or the instruction is newly executable. Change
393 // the value type of I to reflect these changes if appropriate. This method
394 // makes sure to do the following actions:
396 // 1. If a phi node merges two constants in, and has conflicting value coming
397 // from different branches, or if the PHI node merges in an overdefined
398 // value, then the PHI node becomes overdefined.
399 // 2. If a phi node merges only constants in, and they all agree on value, the
400 // PHI node becomes a constant value equal to that.
401 // 3. If V <- x (op) y && isConstant(x) && isConstant(y) V = Constant
402 // 4. If V <- x (op) y && (isOverdefined(x) || isOverdefined(y)) V = Overdefined
403 // 5. If V <- MEM or V <- CALL or V <- (unknown) then V = Overdefined
404 // 6. If a conditional branch has a value that is constant, make the selected
405 // destination executable
406 // 7. If a conditional branch has a value that is overdefined, make all
407 // successors executable.
409 void SCCP::visitPHINode(PHINode &PN) {
410 if (getValueState(&PN).isOverdefined()) return; // Quick exit
412 // Look at all of the executable operands of the PHI node. If any of them
413 // are overdefined, the PHI becomes overdefined as well. If they are all
414 // constant, and they agree with each other, the PHI becomes the identical
415 // constant. If they are constant and don't agree, the PHI is overdefined.
416 // If there are no executable operands, the PHI remains undefined.
418 Constant *OperandVal = 0;
419 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
420 InstVal &IV = getValueState(PN.getIncomingValue(i));
421 if (IV.isUndefined()) continue; // Doesn't influence PHI node.
422 if (IV.isOverdefined()) { // PHI node becomes overdefined!
423 markOverdefined(&PN);
427 if (isEdgeFeasible(PN.getIncomingBlock(i), PN.getParent())) {
428 if (OperandVal == 0) { // Grab the first value...
429 OperandVal = IV.getConstant();
430 } else { // Another value is being merged in!
431 // There is already a reachable operand. If we conflict with it,
432 // then the PHI node becomes overdefined. If we agree with it, we
435 // Check to see if there are two different constants merging...
436 if (IV.getConstant() != OperandVal) {
437 // Yes there is. This means the PHI node is not constant.
438 // You must be overdefined poor PHI.
440 markOverdefined(&PN); // The PHI node now becomes overdefined
441 return; // I'm done analyzing you
447 // If we exited the loop, this means that the PHI node only has constant
448 // arguments that agree with each other(and OperandVal is the constant) or
449 // OperandVal is null because there are no defined incoming arguments. If
450 // this is the case, the PHI remains undefined.
453 markConstant(&PN, OperandVal); // Aquire operand value
456 void SCCP::visitTerminatorInst(TerminatorInst &TI) {
457 std::vector<bool> SuccFeasible;
458 getFeasibleSuccessors(TI, SuccFeasible);
460 // Mark all feasible successors executable...
461 for (unsigned i = 0, e = SuccFeasible.size(); i != e; ++i)
462 if (SuccFeasible[i]) {
463 BasicBlock *Succ = TI.getSuccessor(i);
464 markExecutable(Succ);
468 void SCCP::visitCastInst(CastInst &I) {
469 Value *V = I.getOperand(0);
470 InstVal &VState = getValueState(V);
471 if (VState.isOverdefined()) { // Inherit overdefinedness of operand
473 } else if (VState.isConstant()) { // Propagate constant value
475 ConstantFoldCastInstruction(VState.getConstant(), I.getType());
478 // This instruction constant folds!
479 markConstant(&I, Result);
481 markOverdefined(&I); // Don't know how to fold this instruction. :(
486 // Handle BinaryOperators and Shift Instructions...
487 void SCCP::visitBinaryOperator(Instruction &I) {
488 InstVal &V1State = getValueState(I.getOperand(0));
489 InstVal &V2State = getValueState(I.getOperand(1));
490 if (V1State.isOverdefined() || V2State.isOverdefined()) {
492 } else if (V1State.isConstant() && V2State.isConstant()) {
493 Constant *Result = 0;
494 if (isa<BinaryOperator>(I))
495 Result = ConstantFoldBinaryInstruction(I.getOpcode(),
496 V1State.getConstant(),
497 V2State.getConstant());
498 else if (isa<ShiftInst>(I))
499 Result = ConstantFoldShiftInstruction(I.getOpcode(),
500 V1State.getConstant(),
501 V2State.getConstant());
503 markConstant(&I, Result); // This instruction constant folds!
505 markOverdefined(&I); // Don't know how to fold this instruction. :(
509 // Handle getelementptr instructions... if all operands are constants then we
510 // can turn this into a getelementptr ConstantExpr.
512 void SCCP::visitGetElementPtrInst(GetElementPtrInst &I) {
513 std::vector<Constant*> Operands;
514 Operands.reserve(I.getNumOperands());
516 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
517 InstVal &State = getValueState(I.getOperand(i));
518 if (State.isUndefined())
519 return; // Operands are not resolved yet...
520 else if (State.isOverdefined()) {
524 assert(State.isConstant() && "Unknown state!");
525 Operands.push_back(State.getConstant());
528 Constant *Ptr = Operands[0];
529 Operands.erase(Operands.begin()); // Erase the pointer from idx list...
531 markConstant(&I, ConstantExpr::getGetElementPtr(Ptr, Operands));