lib/Transforms/Scalar/SCCP.cpp

   1 //===- SCCP.cpp - Sparse Conditional Constant Propogation -----------------===//
   2 //
   3 // This file implements sparse conditional constant propogation and merging:
   4 //
   5 // Specifically, this:
   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 constant, and unconditionalizes them
  10 //   * Folds multiple identical constants in the constant pool together
  11 //
  12 // Notice that:
  13 //   * This pass has a habit of making definitions be dead.  It is a good idea
  14 //     to to run a DCE pass sometime after running this pass.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "llvm/Transforms/Scalar.h"
  19 #include "llvm/ConstantHandling.h"
  20 #include "llvm/Function.h"
  21 #include "llvm/iPHINode.h"
  22 #include "llvm/iMemory.h"
  23 #include "llvm/iTerminators.h"
  24 #include "llvm/iOther.h"
  25 #include "llvm/Pass.h"
  26 #include "llvm/Support/InstVisitor.h"
  27 #include "Support/STLExtras.h"
  28 #include "Support/StatisticReporter.h"
  29 #include <algorithm>
  30 #include <set>
  31 using std::cerr;
  32
  33 static Statistic<> NumInstRemoved("sccp\t\t- Number of instructions removed");
  34
  35 // InstVal class - This class represents the different lattice values that an
  36 // instruction may occupy.  It is a simple class with value semantics.
  37 //
  38 namespace {
  39 class InstVal {
  40   enum {
  41     undefined,           // This instruction has no known value
  42     constant,            // This instruction has a constant value
  43     // Range,            // This instruction is known to fall within a range
  44     overdefined          // This instruction has an unknown value
  45   } LatticeValue;        // The current lattice position
  46   Constant *ConstantVal; // If Constant value, the current value
  47 public:
  48   inline InstVal() : LatticeValue(undefined), ConstantVal(0) {}
  49
  50   // markOverdefined - Return true if this is a new status to be in...
  51   inline bool markOverdefined() {
  52     if (LatticeValue != overdefined) {
  53       LatticeValue = overdefined;
  54       return true;
  55     }
  56     return false;
  57   }
  58
  59   // markConstant - Return true if this is a new status for us...
  60   inline bool markConstant(Constant *V) {
  61     if (LatticeValue != constant) {
  62       LatticeValue = constant;
  63       ConstantVal = V;
  64       return true;
  65     } else {
  66       assert(ConstantVal == V && "Marking constant with different value");
  67     }
  68     return false;
  69   }
  70
  71   inline bool isUndefined()   const { return LatticeValue == undefined; }
  72   inline bool isConstant()    const { return LatticeValue == constant; }
  73   inline bool isOverdefined() const { return LatticeValue == overdefined; }
  74
  75   inline Constant *getConstant() const { return ConstantVal; }
  76 };
  77
  78 } // end anonymous namespace
  79
  80
  81 //===----------------------------------------------------------------------===//
  82 // SCCP Class
  83 //
  84 // This class does all of the work of Sparse Conditional Constant Propogation.
  85 //
  86 namespace {
  87 class SCCP : public FunctionPass, public InstVisitor<SCCP> {
  88   std::set<BasicBlock*>     BBExecutable;// The basic blocks that are executable
  89   std::map<Value*, InstVal> ValueState;  // The state each value is in...
  90
  91   std::vector<Instruction*> InstWorkList;// The instruction work list
  92   std::vector<BasicBlock*>  BBWorkList;  // The BasicBlock work list
  93 public:
  94
  95   // runOnFunction - Run the Sparse Conditional Constant Propogation algorithm,
  96   // and return true if the function was modified.
  97   //
  98   bool runOnFunction(Function &F);
  99
 100   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 101     AU.preservesCFG();
 102   }
 103
 104
 105   //===--------------------------------------------------------------------===//
 106   // The implementation of this class
 107   //
 108 private:
 109   friend class InstVisitor<SCCP>;        // Allow callbacks from visitor
 110
 111   // markValueOverdefined - Make a value be marked as "constant".  If the value
 112   // is not already a constant, add it to the instruction work list so that
 113   // the users of the instruction are updated later.
 114   //
 115   inline bool markConstant(Instruction *I, Constant *V) {
 116     DEBUG(cerr << "markConstant: " << V << " = " << I);
 117
 118     if (ValueState[I].markConstant(V)) {
 119       InstWorkList.push_back(I);
 120       return true;
 121     }
 122     return false;
 123   }
 124
 125   // markValueOverdefined - Make a value be marked as "overdefined". If the
 126   // value is not already overdefined, add it to the instruction work list so
 127   // that the users of the instruction are updated later.
 128   //
 129   inline bool markOverdefined(Value *V) {
 130     if (ValueState[V].markOverdefined()) {
 131       if (Instruction *I = dyn_cast<Instruction>(V)) {
 132         DEBUG(cerr << "markOverdefined: " << V);
 133         InstWorkList.push_back(I);  // Only instructions go on the work list
 134       }
 135       return true;
 136     }
 137     return false;
 138   }
 139
 140   // getValueState - Return the InstVal object that corresponds to the value.
 141   // This function is neccesary because not all values should start out in the
 142   // underdefined state... Argument's should be overdefined, and
 143   // constants should be marked as constants.  If a value is not known to be an
 144   // Instruction object, then use this accessor to get its value from the map.
 145   //
 146   inline InstVal &getValueState(Value *V) {
 147     std::map<Value*, InstVal>::iterator I = ValueState.find(V);
 148     if (I != ValueState.end()) return I->second;  // Common case, in the map
 149
 150     if (Constant *CPV = dyn_cast<Constant>(V)) {  // Constants are constant
 151       ValueState[CPV].markConstant(CPV);
 152     } else if (isa<Argument>(V)) {                // Arguments are overdefined
 153       ValueState[V].markOverdefined();
 154     }
 155     // All others are underdefined by default...
 156     return ValueState[V];
 157   }
 158
 159   // markExecutable - Mark a basic block as executable, adding it to the BB
 160   // work list if it is not already executable...
 161   //
 162   void markExecutable(BasicBlock *BB) {
 163     if (BBExecutable.count(BB)) return;
 164     DEBUG(cerr << "Marking BB Executable: " << *BB);
 165     BBExecutable.insert(BB);   // Basic block is executable!
 166     BBWorkList.push_back(BB);  // Add the block to the work list!
 167   }
 168
 169
 170   // visit implementations - Something changed in this instruction... Either an
 171   // operand made a transition, or the instruction is newly executable.  Change
 172   // the value type of I to reflect these changes if appropriate.
 173   //
 174   void visitPHINode(PHINode &I);
 175
 176   // Terminators
 177   void visitReturnInst(ReturnInst &I) { /*does not have an effect*/ }
 178   void visitTerminatorInst(TerminatorInst &TI);
 179
 180   void visitCastInst(CastInst &I);
 181   void visitBinaryOperator(Instruction &I);
 182   void visitShiftInst(ShiftInst &I) { visitBinaryOperator(I); }
 183
 184   // Instructions that cannot be folded away...
 185   void visitStoreInst     (Instruction &I) { /*returns void*/ }
 186   void visitMemAccessInst (Instruction &I) { markOverdefined(&I); }
 187   void visitCallInst      (Instruction &I) { markOverdefined(&I); }
 188   void visitInvokeInst    (Instruction &I) { markOverdefined(&I); }
 189   void visitAllocationInst(Instruction &I) { markOverdefined(&I); }
 190   void visitFreeInst      (Instruction &I) { /*returns void*/ }
 191
 192   void visitInstruction(Instruction &I) {
 193     // If a new instruction is added to LLVM that we don't handle...
 194     cerr << "SCCP: Don't know how to handle: " << I;
 195     markOverdefined(&I);   // Just in case
 196   }
 197
 198   // getFeasibleSuccessors - Return a vector of booleans to indicate which
 199   // successors are reachable from a given terminator instruction.
 200   //
 201   void getFeasibleSuccessors(TerminatorInst &TI, std::vector<bool> &Succs);
 202
 203   // isEdgeFeasible - Return true if the control flow edge from the 'From' basic
 204   // block to the 'To' basic block is currently feasible...
 205   //
 206   bool isEdgeFeasible(BasicBlock *From, BasicBlock *To);
 207
 208   // OperandChangedState - This method is invoked on all of the users of an
 209   // instruction that was just changed state somehow....  Based on this
 210   // information, we need to update the specified user of this instruction.
 211   //
 212   void OperandChangedState(User *U) {
 213     // Only instructions use other variable values!
 214     Instruction &I = cast<Instruction>(*U);
 215     if (!BBExecutable.count(I.getParent())) return;// Inst not executable yet!
 216     visit(I);
 217   }
 218 };
 219
 220   RegisterOpt<SCCP> X("sccp", "Sparse Conditional Constant Propogation");
 221 } // end anonymous namespace
 222
 223
 224 // createSCCPPass - This is the public interface to this file...
 225 //
 226 Pass *createSCCPPass() {
 227   return new SCCP();
 228 }
 229
 230
 231 //===----------------------------------------------------------------------===//
 232 // SCCP Class Implementation
 233
 234
 235 // runOnFunction() - Run the Sparse Conditional Constant Propogation algorithm,
 236 // and return true if the function was modified.
 237 //
 238 bool SCCP::runOnFunction(Function &F) {
 239   // Mark the first block of the function as being executable...
 240   markExecutable(&F.front());
 241
 242   // Process the work lists until their are empty!
 243   while (!BBWorkList.empty() || !InstWorkList.empty()) {
 244     // Process the instruction work list...
 245     while (!InstWorkList.empty()) {
 246       Instruction *I = InstWorkList.back();
 247       InstWorkList.pop_back();
 248
 249       DEBUG(cerr << "\nPopped off I-WL: " << I);
 250
 251
 252       // "I" got into the work list because it either made the transition from
 253       // bottom to constant, or to Overdefined.
 254       //
 255       // Update all of the users of this instruction's value...
 256       //
 257       for_each(I->use_begin(), I->use_end(),
 258                bind_obj(this, &SCCP::OperandChangedState));
 259     }
 260
 261     // Process the basic block work list...
 262     while (!BBWorkList.empty()) {
 263       BasicBlock *BB = BBWorkList.back();
 264       BBWorkList.pop_back();
 265
 266       DEBUG(cerr << "\nPopped off BBWL: " << BB);
 267
 268       // If this block only has a single successor, mark it as executable as
 269       // well... if not, terminate the do loop.
 270       //
 271       if (BB->getTerminator()->getNumSuccessors() == 1)
 272         markExecutable(BB->getTerminator()->getSuccessor(0));
 273
 274       // Notify all instructions in this basic block that they are newly
 275       // executable.
 276       visit(BB);
 277     }
 278   }
 279
 280   if (DebugFlag) {
 281     for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
 282       if (!BBExecutable.count(I))
 283         cerr << "BasicBlock Dead:" << *I;
 284   }
 285
 286   // Iterate over all of the instructions in a function, replacing them with
 287   // constants if we have found them to be of constant values.
 288   //
 289   bool MadeChanges = false;
 290   for (Function::iterator BB = F.begin(), BBE = F.end(); BB != BBE; ++BB)
 291     for (BasicBlock::iterator BI = BB->begin(); BI != BB->end();) {
 292       Instruction &Inst = *BI;
 293       InstVal &IV = ValueState[&Inst];
 294       if (IV.isConstant()) {
 295         Constant *Const = IV.getConstant();
 296         DEBUG(cerr << "Constant: " << Const << " = " << Inst);
 297
 298         // Replaces all of the uses of a variable with uses of the constant.
 299         Inst.replaceAllUsesWith(Const);
 300
 301         // Remove the operator from the list of definitions... and delete it.
 302         BI = BB->getInstList().erase(BI);
 303
 304         // Hey, we just changed something!
 305         MadeChanges = true;
 306         ++NumInstRemoved;
 307       } else {
 308         ++BI;
 309       }
 310     }
 311
 312   // Reset state so that the next invocation will have empty data structures
 313   BBExecutable.clear();
 314   ValueState.clear();
 315
 316   return MadeChanges;
 317 }
 318
 319
 320 // getFeasibleSuccessors - Return a vector of booleans to indicate which
 321 // successors are reachable from a given terminator instruction.
 322 //
 323 void SCCP::getFeasibleSuccessors(TerminatorInst &TI, std::vector<bool> &Succs) {
 324   assert(Succs.size() == TI.getNumSuccessors() && "Succs vector wrong size!");
 325   if (BranchInst *BI = dyn_cast<BranchInst>(&TI)) {
 326     if (BI->isUnconditional()) {
 327       Succs[0] = true;
 328     } else {
 329       InstVal &BCValue = getValueState(BI->getCondition());
 330       if (BCValue.isOverdefined()) {
 331         // Overdefined condition variables mean the branch could go either way.
 332         Succs[0] = Succs[1] = true;
 333       } else if (BCValue.isConstant()) {
 334         // Constant condition variables mean the branch can only go a single way
 335         Succs[BCValue.getConstant() == ConstantBool::False] = true;
 336       }
 337     }
 338   } else if (InvokeInst *II = dyn_cast<InvokeInst>(&TI)) {
 339     // Invoke instructions successors are always executable.
 340     Succs[0] = Succs[1] = true;
 341   } else if (SwitchInst *SI = dyn_cast<SwitchInst>(&TI)) {
 342     InstVal &SCValue = getValueState(SI->getCondition());
 343     if (SCValue.isOverdefined()) {  // Overdefined condition?
 344       // All destinations are executable!
 345       Succs.assign(TI.getNumSuccessors(), true);
 346     } else if (SCValue.isConstant()) {
 347       Constant *CPV = SCValue.getConstant();
 348       // Make sure to skip the "default value" which isn't a value
 349       for (unsigned i = 1, E = SI->getNumSuccessors(); i != E; ++i) {
 350         if (SI->getSuccessorValue(i) == CPV) {// Found the right branch...
 351           Succs[i] = true;
 352           return;
 353         }
 354       }
 355
 356       // Constant value not equal to any of the branches... must execute
 357       // default branch then...
 358       Succs[0] = true;
 359     }
 360   } else {
 361     cerr << "SCCP: Don't know how to handle: " << TI;
 362     Succs.assign(TI.getNumSuccessors(), true);
 363   }
 364 }
 365
 366
 367 // isEdgeFeasible - Return true if the control flow edge from the 'From' basic
 368 // block to the 'To' basic block is currently feasible...
 369 //
 370 bool SCCP::isEdgeFeasible(BasicBlock *From, BasicBlock *To) {
 371   assert(BBExecutable.count(To) && "Dest should always be alive!");
 372
 373   // Make sure the source basic block is executable!!
 374   if (!BBExecutable.count(From)) return false;
 375
 376   // Check to make sure this edge itself is actually feasible now...
 377   TerminatorInst *FT = From->getTerminator();
 378   std::vector<bool> SuccFeasible(FT->getNumSuccessors());
 379   getFeasibleSuccessors(*FT, SuccFeasible);
 380
 381   // Check all edges from From to To.  If any are feasible, return true.
 382   for (unsigned i = 0, e = SuccFeasible.size(); i != e; ++i)
 383     if (FT->getSuccessor(i) == To && SuccFeasible[i])
 384       return true;
 385
 386   // Otherwise, none of the edges are actually feasible at this time...
 387   return false;
 388 }
 389
 390 // visit Implementations - Something changed in this instruction... Either an
 391 // operand made a transition, or the instruction is newly executable.  Change
 392 // the value type of I to reflect these changes if appropriate.  This method
 393 // makes sure to do the following actions:
 394 //
 395 // 1. If a phi node merges two constants in, and has conflicting value coming
 396 //    from different branches, or if the PHI node merges in an overdefined
 397 //    value, then the PHI node becomes overdefined.
 398 // 2. If a phi node merges only constants in, and they all agree on value, the
 399 //    PHI node becomes a constant value equal to that.
 400 // 3. If V <- x (op) y && isConstant(x) && isConstant(y) V = Constant
 401 // 4. If V <- x (op) y && (isOverdefined(x) || isOverdefined(y)) V = Overdefined
 402 // 5. If V <- MEM or V <- CALL or V <- (unknown) then V = Overdefined
 403 // 6. If a conditional branch has a value that is constant, make the selected
 404 //    destination executable
 405 // 7. If a conditional branch has a value that is overdefined, make all
 406 //    successors executable.
 407 //
 408
 409 void SCCP::visitPHINode(PHINode &PN) {
 410   unsigned NumValues = PN.getNumIncomingValues(), i;
 411   InstVal *OperandIV = 0;
 412
 413   // Look at all of the executable operands of the PHI node.  If any of them
 414   // are overdefined, the PHI becomes overdefined as well.  If they are all
 415   // constant, and they agree with each other, the PHI becomes the identical
 416   // constant.  If they are constant and don't agree, the PHI is overdefined.
 417   // If there are no executable operands, the PHI remains undefined.
 418   //
 419   for (i = 0; i < NumValues; ++i) {
 420     if (isEdgeFeasible(PN.getIncomingBlock(i), PN.getParent())) {
 421       InstVal &IV = getValueState(PN.getIncomingValue(i));
 422       if (IV.isUndefined()) continue;  // Doesn't influence PHI node.
 423       if (IV.isOverdefined()) {   // PHI node becomes overdefined!
 424         markOverdefined(&PN);
 425         return;
 426       }
 427
 428       if (OperandIV == 0) {   // Grab the first value...
 429         OperandIV = &IV;
 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
 433         // can continue on.
 434
 435         // Check to see if there are two different constants merging...
 436         if (IV.getConstant() != OperandIV->getConstant()) {
 437           // Yes there is.  This means the PHI node is not constant.
 438           // You must be overdefined poor PHI.
 439           //
 440           markOverdefined(&PN);         // The PHI node now becomes overdefined
 441           return;    // I'm done analyzing you
 442         }
 443       }
 444     }
 445   }
 446
 447   // If we exited the loop, this means that the PHI node only has constant
 448   // arguments that agree with each other(and OperandIV is a pointer to one
 449   // of their InstVal's) or OperandIV is null because there are no defined
 450   // incoming arguments.  If this is the case, the PHI remains undefined.
 451   //
 452   if (OperandIV) {
 453     assert(OperandIV->isConstant() && "Should only be here for constants!");
 454     markConstant(&PN, OperandIV->getConstant());  // Aquire operand value
 455   }
 456 }
 457
 458 void SCCP::visitTerminatorInst(TerminatorInst &TI) {
 459   std::vector<bool> SuccFeasible(TI.getNumSuccessors());
 460   getFeasibleSuccessors(TI, SuccFeasible);
 461
 462   // Mark all feasible successors executable...
 463   for (unsigned i = 0, e = SuccFeasible.size(); i != e; ++i)
 464     if (SuccFeasible[i]) {
 465       BasicBlock *Succ = TI.getSuccessor(i);
 466       markExecutable(Succ);
 467
 468       // Visit all of the PHI nodes that merge values from this block...
 469       // Because this edge may be new executable, and PHI nodes that used to be
 470       // constant now may not be.
 471       //
 472       for (BasicBlock::iterator I = Succ->begin();
 473            PHINode *PN = dyn_cast<PHINode>(&*I); ++I)
 474         visitPHINode(*PN);
 475     }
 476 }
 477
 478 void SCCP::visitCastInst(CastInst &I) {
 479   Value *V = I.getOperand(0);
 480   InstVal &VState = getValueState(V);
 481   if (VState.isOverdefined()) {        // Inherit overdefinedness of operand
 482     markOverdefined(&I);
 483   } else if (VState.isConstant()) {    // Propogate constant value
 484     Constant *Result =
 485       ConstantFoldCastInstruction(VState.getConstant(), I.getType());
 486
 487     if (Result) {
 488       // This instruction constant folds!
 489       markConstant(&I, Result);
 490     } else {
 491       markOverdefined(&I);   // Don't know how to fold this instruction.  :(
 492     }
 493   }
 494 }
 495
 496 // Handle BinaryOperators and Shift Instructions...
 497 void SCCP::visitBinaryOperator(Instruction &I) {
 498   InstVal &V1State = getValueState(I.getOperand(0));
 499   InstVal &V2State = getValueState(I.getOperand(1));
 500   if (V1State.isOverdefined() || V2State.isOverdefined()) {
 501     markOverdefined(&I);
 502   } else if (V1State.isConstant() && V2State.isConstant()) {
 503     Constant *Result = 0;
 504     if (isa<BinaryOperator>(I))
 505       Result = ConstantFoldBinaryInstruction(I.getOpcode(),
 506                                              V1State.getConstant(),
 507                                              V2State.getConstant());
 508     else if (isa<ShiftInst>(I))
 509       Result = ConstantFoldShiftInstruction(I.getOpcode(),
 510                                             V1State.getConstant(),
 511                                             V2State.getConstant());
 512     if (Result)
 513       markConstant(&I, Result);      // This instruction constant folds!
 514     else
 515       markOverdefined(&I);   // Don't know how to fold this instruction.  :(
 516   }
 517 }