lib/Transforms/Scalar/SCCP.cpp

   1 //===- SCCP.cpp - Sparse Conditional Constant Propagation -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements sparse conditional constant propagation and merging:
  11 //
  12 // Specifically, this:
  13 //   * Assumes values are constant unless proven otherwise
  14 //   * Assumes BasicBlocks are dead unless proven otherwise
  15 //   * Proves values to be constant, and replaces them with constants
  16 //   * Proves conditional branches to be unconditional
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #define DEBUG_TYPE "sccp"
  21 #include "llvm/Transforms/Scalar.h"
  22 #include "llvm/Transforms/IPO.h"
  23 #include "llvm/Constants.h"
  24 #include "llvm/DerivedTypes.h"
  25 #include "llvm/Instructions.h"
  26 #include "llvm/Pass.h"
  27 #include "llvm/Analysis/ConstantFolding.h"
  28 #include "llvm/Analysis/ValueTracking.h"
  29 #include "llvm/Transforms/Utils/Local.h"
  30 #include "llvm/Target/TargetData.h"
  31 #include "llvm/Support/CallSite.h"
  32 #include "llvm/Support/Debug.h"
  33 #include "llvm/Support/ErrorHandling.h"
  34 #include "llvm/Support/InstVisitor.h"
  35 #include "llvm/Support/raw_ostream.h"
  36 #include "llvm/ADT/DenseMap.h"
  37 #include "llvm/ADT/DenseSet.h"
  38 #include "llvm/ADT/PointerIntPair.h"
  39 #include "llvm/ADT/SmallPtrSet.h"
  40 #include "llvm/ADT/SmallVector.h"
  41 #include "llvm/ADT/Statistic.h"
  42 #include "llvm/ADT/STLExtras.h"
  43 #include <algorithm>
  44 #include <map>
  45 using namespace llvm;
  46
  47 STATISTIC(NumInstRemoved, "Number of instructions removed");
  48 STATISTIC(NumDeadBlocks , "Number of basic blocks unreachable");
  49
  50 STATISTIC(IPNumInstRemoved, "Number of instructions removed by IPSCCP");
  51 STATISTIC(IPNumArgsElimed ,"Number of arguments constant propagated by IPSCCP");
  52 STATISTIC(IPNumGlobalConst, "Number of globals found to be constant by IPSCCP");
  53
  54 namespace {
  55 /// LatticeVal class - This class represents the different lattice values that
  56 /// an LLVM value may occupy.  It is a simple class with value semantics.
  57 ///
  58 class LatticeVal {
  59   enum LatticeValueTy {
  60     /// undefined - This LLVM Value has no known value yet.
  61     undefined,
  62
  63     /// constant - This LLVM Value has a specific constant value.
  64     constant,
  65
  66     /// forcedconstant - This LLVM Value was thought to be undef until
  67     /// ResolvedUndefsIn.  This is treated just like 'constant', but if merged
  68     /// with another (different) constant, it goes to overdefined, instead of
  69     /// asserting.
  70     forcedconstant,
  71
  72     /// overdefined - This instruction is not known to be constant, and we know
  73     /// it has a value.
  74     overdefined
  75   };
  76
  77   /// Val: This stores the current lattice value along with the Constant* for
  78   /// the constant if this is a 'constant' or 'forcedconstant' value.
  79   PointerIntPair<Constant *, 2, LatticeValueTy> Val;
  80
  81   LatticeValueTy getLatticeValue() const {
  82     return Val.getInt();
  83   }
  84
  85 public:
  86   LatticeVal() : Val(0, undefined) {}
  87
  88   bool isUndefined() const { return getLatticeValue() == undefined; }
  89   bool isConstant() const {
  90     return getLatticeValue() == constant || getLatticeValue() == forcedconstant;
  91   }
  92   bool isOverdefined() const { return getLatticeValue() == overdefined; }
  93
  94   Constant *getConstant() const {
  95     assert(isConstant() && "Cannot get the constant of a non-constant!");
  96     return Val.getPointer();
  97   }
  98
  99   /// markOverdefined - Return true if this is a change in status.
 100   bool markOverdefined() {
 101     if (isOverdefined())
 102       return false;
 103
 104     Val.setInt(overdefined);
 105     return true;
 106   }
 107
 108   /// markConstant - Return true if this is a change in status.
 109   bool markConstant(Constant *V) {
 110     if (getLatticeValue() == constant) { // Constant but not forcedconstant.
 111       assert(getConstant() == V && "Marking constant with different value");
 112       return false;
 113     }
 114
 115     if (isUndefined()) {
 116       Val.setInt(constant);
 117       assert(V && "Marking constant with NULL");
 118       Val.setPointer(V);
 119     } else {
 120       assert(getLatticeValue() == forcedconstant &&
 121              "Cannot move from overdefined to constant!");
 122       // Stay at forcedconstant if the constant is the same.
 123       if (V == getConstant()) return false;
 124
 125       // Otherwise, we go to overdefined.  Assumptions made based on the
 126       // forced value are possibly wrong.  Assuming this is another constant
 127       // could expose a contradiction.
 128       Val.setInt(overdefined);
 129     }
 130     return true;
 131   }
 132
 133   /// getConstantInt - If this is a constant with a ConstantInt value, return it
 134   /// otherwise return null.
 135   ConstantInt *getConstantInt() const {
 136     if (isConstant())
 137       return dyn_cast<ConstantInt>(getConstant());
 138     return 0;
 139   }
 140
 141   void markForcedConstant(Constant *V) {
 142     assert(isUndefined() && "Can't force a defined value!");
 143     Val.setInt(forcedconstant);
 144     Val.setPointer(V);
 145   }
 146 };
 147 } // end anonymous namespace.
 148
 149
 150 namespace {
 151
 152 //===----------------------------------------------------------------------===//
 153 //
 154 /// SCCPSolver - This class is a general purpose solver for Sparse Conditional
 155 /// Constant Propagation.
 156 ///
 157 class SCCPSolver : public InstVisitor<SCCPSolver> {
 158   const TargetData *TD;
 159   SmallPtrSet<BasicBlock*, 8> BBExecutable;// The BBs that are executable.
 160   DenseMap<Value*, LatticeVal> ValueState;  // The state each value is in.
 161
 162   /// StructValueState - This maintains ValueState for values that have
 163   /// StructType, for example for formal arguments, calls, insertelement, etc.
 164   ///
 165   DenseMap<std::pair<Value*, unsigned>, LatticeVal> StructValueState;
 166
 167   /// GlobalValue - If we are tracking any values for the contents of a global
 168   /// variable, we keep a mapping from the constant accessor to the element of
 169   /// the global, to the currently known value.  If the value becomes
 170   /// overdefined, it's entry is simply removed from this map.
 171   DenseMap<GlobalVariable*, LatticeVal> TrackedGlobals;
 172
 173   /// TrackedRetVals - If we are tracking arguments into and the return
 174   /// value out of a function, it will have an entry in this map, indicating
 175   /// what the known return value for the function is.
 176   DenseMap<Function*, LatticeVal> TrackedRetVals;
 177
 178   /// TrackedMultipleRetVals - Same as TrackedRetVals, but used for functions
 179   /// that return multiple values.
 180   DenseMap<std::pair<Function*, unsigned>, LatticeVal> TrackedMultipleRetVals;
 181
 182   /// MRVFunctionsTracked - Each function in TrackedMultipleRetVals is
 183   /// represented here for efficient lookup.
 184   SmallPtrSet<Function*, 16> MRVFunctionsTracked;
 185
 186   /// TrackingIncomingArguments - This is the set of functions for whose
 187   /// arguments we make optimistic assumptions about and try to prove as
 188   /// constants.
 189   SmallPtrSet<Function*, 16> TrackingIncomingArguments;
 190
 191   /// The reason for two worklists is that overdefined is the lowest state
 192   /// on the lattice, and moving things to overdefined as fast as possible
 193   /// makes SCCP converge much faster.
 194   ///
 195   /// By having a separate worklist, we accomplish this because everything
 196   /// possibly overdefined will become overdefined at the soonest possible
 197   /// point.
 198   SmallVector<Value*, 64> OverdefinedInstWorkList;
 199   SmallVector<Value*, 64> InstWorkList;
 200
 201
 202   SmallVector<BasicBlock*, 64>  BBWorkList;  // The BasicBlock work list
 203
 204   /// UsersOfOverdefinedPHIs - Keep track of any users of PHI nodes that are not
 205   /// overdefined, despite the fact that the PHI node is overdefined.
 206   std::multimap<PHINode*, Instruction*> UsersOfOverdefinedPHIs;
 207
 208   /// KnownFeasibleEdges - Entries in this set are edges which have already had
 209   /// PHI nodes retriggered.
 210   typedef std::pair<BasicBlock*, BasicBlock*> Edge;
 211   DenseSet<Edge> KnownFeasibleEdges;
 212 public:
 213   SCCPSolver(const TargetData *td) : TD(td) {}
 214
 215   /// MarkBlockExecutable - This method can be used by clients to mark all of
 216   /// the blocks that are known to be intrinsically live in the processed unit.
 217   ///
 218   /// This returns true if the block was not considered live before.
 219   bool MarkBlockExecutable(BasicBlock *BB) {
 220     if (!BBExecutable.insert(BB)) return false;
 221     DEBUG(dbgs() << "Marking Block Executable: " << BB->getName() << "\n");
 222     BBWorkList.push_back(BB);  // Add the block to the work list!
 223     return true;
 224   }
 225
 226   /// TrackValueOfGlobalVariable - Clients can use this method to
 227   /// inform the SCCPSolver that it should track loads and stores to the
 228   /// specified global variable if it can.  This is only legal to call if
 229   /// performing Interprocedural SCCP.
 230   void TrackValueOfGlobalVariable(GlobalVariable *GV) {
 231     // We only track the contents of scalar globals.
 232     if (GV->getType()->getElementType()->isSingleValueType()) {
 233       LatticeVal &IV = TrackedGlobals[GV];
 234       if (!isa<UndefValue>(GV->getInitializer()))
 235         IV.markConstant(GV->getInitializer());
 236     }
 237   }
 238
 239   /// AddTrackedFunction - If the SCCP solver is supposed to track calls into
 240   /// and out of the specified function (which cannot have its address taken),
 241   /// this method must be called.
 242   void AddTrackedFunction(Function *F) {
 243     // Add an entry, F -> undef.
 244     if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
 245       MRVFunctionsTracked.insert(F);
 246       for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
 247         TrackedMultipleRetVals.insert(std::make_pair(std::make_pair(F, i),
 248                                                      LatticeVal()));
 249     } else
 250       TrackedRetVals.insert(std::make_pair(F, LatticeVal()));
 251   }
 252
 253   void AddArgumentTrackedFunction(Function *F) {
 254     TrackingIncomingArguments.insert(F);
 255   }
 256
 257   /// Solve - Solve for constants and executable blocks.
 258   ///
 259   void Solve();
 260
 261   /// ResolvedUndefsIn - While solving the dataflow for a function, we assume
 262   /// that branches on undef values cannot reach any of their successors.
 263   /// However, this is not a safe assumption.  After we solve dataflow, this
 264   /// method should be use to handle this.  If this returns true, the solver
 265   /// should be rerun.
 266   bool ResolvedUndefsIn(Function &F);
 267
 268   bool isBlockExecutable(BasicBlock *BB) const {
 269     return BBExecutable.count(BB);
 270   }
 271
 272   LatticeVal getLatticeValueFor(Value *V) const {
 273     DenseMap<Value*, LatticeVal>::const_iterator I = ValueState.find(V);
 274     assert(I != ValueState.end() && "V is not in valuemap!");
 275     return I->second;
 276   }
 277
 278   /*LatticeVal getStructLatticeValueFor(Value *V, unsigned i) const {
 279     DenseMap<std::pair<Value*, unsigned>, LatticeVal>::const_iterator I =
 280       StructValueState.find(std::make_pair(V, i));
 281     assert(I != StructValueState.end() && "V is not in valuemap!");
 282     return I->second;
 283   }*/
 284
 285   /// getTrackedRetVals - Get the inferred return value map.
 286   ///
 287   const DenseMap<Function*, LatticeVal> &getTrackedRetVals() {
 288     return TrackedRetVals;
 289   }
 290
 291   /// getTrackedGlobals - Get and return the set of inferred initializers for
 292   /// global variables.
 293   const DenseMap<GlobalVariable*, LatticeVal> &getTrackedGlobals() {
 294     return TrackedGlobals;
 295   }
 296
 297   void markOverdefined(Value *V) {
 298     assert(!V->getType()->isStructTy() && "Should use other method");
 299     markOverdefined(ValueState[V], V);
 300   }
 301
 302   /// markAnythingOverdefined - Mark the specified value overdefined.  This
 303   /// works with both scalars and structs.
 304   void markAnythingOverdefined(Value *V) {
 305     if (const StructType *STy = dyn_cast<StructType>(V->getType()))
 306       for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
 307         markOverdefined(getStructValueState(V, i), V);
 308     else
 309       markOverdefined(V);
 310   }
 311
 312 private:
 313   // markConstant - Make a value be marked as "constant".  If the value
 314   // is not already a constant, add it to the instruction work list so that
 315   // the users of the instruction are updated later.
 316   //
 317   void markConstant(LatticeVal &IV, Value *V, Constant *C) {
 318     if (!IV.markConstant(C)) return;
 319     DEBUG(dbgs() << "markConstant: " << *C << ": " << *V << '\n');
 320     if (IV.isOverdefined())
 321       OverdefinedInstWorkList.push_back(V);
 322     else
 323       InstWorkList.push_back(V);
 324   }
 325
 326   void markConstant(Value *V, Constant *C) {
 327     assert(!V->getType()->isStructTy() && "Should use other method");
 328     markConstant(ValueState[V], V, C);
 329   }
 330
 331   void markForcedConstant(Value *V, Constant *C) {
 332     assert(!V->getType()->isStructTy() && "Should use other method");
 333     LatticeVal &IV = ValueState[V];
 334     IV.markForcedConstant(C);
 335     DEBUG(dbgs() << "markForcedConstant: " << *C << ": " << *V << '\n');
 336     if (IV.isOverdefined())
 337       OverdefinedInstWorkList.push_back(V);
 338     else
 339       InstWorkList.push_back(V);
 340   }
 341
 342
 343   // markOverdefined - Make a value be marked as "overdefined". If the
 344   // value is not already overdefined, add it to the overdefined instruction
 345   // work list so that the users of the instruction are updated later.
 346   void markOverdefined(LatticeVal &IV, Value *V) {
 347     if (!IV.markOverdefined()) return;
 348
 349     DEBUG(dbgs() << "markOverdefined: ";
 350           if (Function *F = dyn_cast<Function>(V))
 351             dbgs() << "Function '" << F->getName() << "'\n";
 352           else
 353             dbgs() << *V << '\n');
 354     // Only instructions go on the work list
 355     OverdefinedInstWorkList.push_back(V);
 356   }
 357
 358   void mergeInValue(LatticeVal &IV, Value *V, LatticeVal MergeWithV) {
 359     if (IV.isOverdefined() || MergeWithV.isUndefined())
 360       return;  // Noop.
 361     if (MergeWithV.isOverdefined())
 362       markOverdefined(IV, V);
 363     else if (IV.isUndefined())
 364       markConstant(IV, V, MergeWithV.getConstant());
 365     else if (IV.getConstant() != MergeWithV.getConstant())
 366       markOverdefined(IV, V);
 367   }
 368
 369   void mergeInValue(Value *V, LatticeVal MergeWithV) {
 370     assert(!V->getType()->isStructTy() && "Should use other method");
 371     mergeInValue(ValueState[V], V, MergeWithV);
 372   }
 373
 374
 375   /// getValueState - Return the LatticeVal object that corresponds to the
 376   /// value.  This function handles the case when the value hasn't been seen yet
 377   /// by properly seeding constants etc.
 378   LatticeVal &getValueState(Value *V) {
 379     assert(!V->getType()->isStructTy() && "Should use getStructValueState");
 380
 381     std::pair<DenseMap<Value*, LatticeVal>::iterator, bool> I =
 382       ValueState.insert(std::make_pair(V, LatticeVal()));
 383     LatticeVal &LV = I.first->second;
 384
 385     if (!I.second)
 386       return LV;  // Common case, already in the map.
 387
 388     if (Constant *C = dyn_cast<Constant>(V)) {
 389       // Undef values remain undefined.
 390       if (!isa<UndefValue>(V))
 391         LV.markConstant(C);          // Constants are constant
 392     }
 393
 394     // All others are underdefined by default.
 395     return LV;
 396   }
 397
 398   /// getStructValueState - Return the LatticeVal object that corresponds to the
 399   /// value/field pair.  This function handles the case when the value hasn't
 400   /// been seen yet by properly seeding constants etc.
 401   LatticeVal &getStructValueState(Value *V, unsigned i) {
 402     assert(V->getType()->isStructTy() && "Should use getValueState");
 403     assert(i < cast<StructType>(V->getType())->getNumElements() &&
 404            "Invalid element #");
 405
 406     std::pair<DenseMap<std::pair<Value*, unsigned>, LatticeVal>::iterator,
 407               bool> I = StructValueState.insert(
 408                         std::make_pair(std::make_pair(V, i), LatticeVal()));
 409     LatticeVal &LV = I.first->second;
 410
 411     if (!I.second)
 412       return LV;  // Common case, already in the map.
 413
 414     if (Constant *C = dyn_cast<Constant>(V)) {
 415       if (isa<UndefValue>(C))
 416         ; // Undef values remain undefined.
 417       else if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C))
 418         LV.markConstant(CS->getOperand(i));      // Constants are constant.
 419       else if (isa<ConstantAggregateZero>(C)) {
 420         const Type *FieldTy = cast<StructType>(V->getType())->getElementType(i);
 421         LV.markConstant(Constant::getNullValue(FieldTy));
 422       } else
 423         LV.markOverdefined();      // Unknown sort of constant.
 424     }
 425
 426     // All others are underdefined by default.
 427     return LV;
 428   }
 429
 430
 431   /// markEdgeExecutable - Mark a basic block as executable, adding it to the BB
 432   /// work list if it is not already executable.
 433   void markEdgeExecutable(BasicBlock *Source, BasicBlock *Dest) {
 434     if (!KnownFeasibleEdges.insert(Edge(Source, Dest)).second)
 435       return;  // This edge is already known to be executable!
 436
 437     if (!MarkBlockExecutable(Dest)) {
 438       // If the destination is already executable, we just made an *edge*
 439       // feasible that wasn't before.  Revisit the PHI nodes in the block
 440       // because they have potentially new operands.
 441       DEBUG(dbgs() << "Marking Edge Executable: " << Source->getName()
 442             << " -> " << Dest->getName() << "\n");
 443
 444       PHINode *PN;
 445       for (BasicBlock::iterator I = Dest->begin();
 446            (PN = dyn_cast<PHINode>(I)); ++I)
 447         visitPHINode(*PN);
 448     }
 449   }
 450
 451   // getFeasibleSuccessors - Return a vector of booleans to indicate which
 452   // successors are reachable from a given terminator instruction.
 453   //
 454   void getFeasibleSuccessors(TerminatorInst &TI, SmallVector<bool, 16> &Succs);
 455
 456   // isEdgeFeasible - Return true if the control flow edge from the 'From' basic
 457   // block to the 'To' basic block is currently feasible.
 458   //
 459   bool isEdgeFeasible(BasicBlock *From, BasicBlock *To);
 460
 461   // OperandChangedState - This method is invoked on all of the users of an
 462   // instruction that was just changed state somehow.  Based on this
 463   // information, we need to update the specified user of this instruction.
 464   //
 465   void OperandChangedState(Instruction *I) {
 466     if (BBExecutable.count(I->getParent()))   // Inst is executable?
 467       visit(*I);
 468   }
 469
 470   /// RemoveFromOverdefinedPHIs - If I has any entries in the
 471   /// UsersOfOverdefinedPHIs map for PN, remove them now.
 472   void RemoveFromOverdefinedPHIs(Instruction *I, PHINode *PN) {
 473     if (UsersOfOverdefinedPHIs.empty()) return;
 474     std::multimap<PHINode*, Instruction*>::iterator It, E;
 475     tie(It, E) = UsersOfOverdefinedPHIs.equal_range(PN);
 476     while (It != E) {
 477       if (It->second == I)
 478         UsersOfOverdefinedPHIs.erase(It++);
 479       else
 480         ++It;
 481     }
 482   }
 483
 484   /// InsertInOverdefinedPHIs - Insert an entry in the UsersOfOverdefinedPHIS
 485   /// map for I and PN, but if one is there already, do not create another.
 486   /// (Duplicate entries do not break anything directly, but can lead to
 487   /// exponential growth of the table in rare cases.)
 488   void InsertInOverdefinedPHIs(Instruction *I, PHINode *PN) {
 489     std::multimap<PHINode*, Instruction*>::iterator J, E;
 490     bool found = false;
 491     tie(J, E) = UsersOfOverdefinedPHIs.equal_range(PN);
 492     for (; J != E; ++J)
 493       if (J->second == I) {
 494         found = true;
 495         break;
 496       }
 497     if (!found)
 498       UsersOfOverdefinedPHIs.insert(std::make_pair(PN, I));
 499   }
 500
 501 private:
 502   friend class InstVisitor<SCCPSolver>;
 503
 504   // visit implementations - Something changed in this instruction.  Either an
 505   // operand made a transition, or the instruction is newly executable.  Change
 506   // the value type of I to reflect these changes if appropriate.
 507   void visitPHINode(PHINode &I);
 508
 509   // Terminators
 510   void visitReturnInst(ReturnInst &I);
 511   void visitTerminatorInst(TerminatorInst &TI);
 512
 513   void visitCastInst(CastInst &I);
 514   void visitSelectInst(SelectInst &I);
 515   void visitBinaryOperator(Instruction &I);
 516   void visitCmpInst(CmpInst &I);
 517   void visitExtractElementInst(ExtractElementInst &I);
 518   void visitInsertElementInst(InsertElementInst &I);
 519   void visitShuffleVectorInst(ShuffleVectorInst &I);
 520   void visitExtractValueInst(ExtractValueInst &EVI);
 521   void visitInsertValueInst(InsertValueInst &IVI);
 522
 523   // Instructions that cannot be folded away.
 524   void visitStoreInst     (StoreInst &I);
 525   void visitLoadInst      (LoadInst &I);
 526   void visitGetElementPtrInst(GetElementPtrInst &I);
 527   void visitCallInst      (CallInst &I) {
 528     visitCallSite(&I);
 529   }
 530   void visitInvokeInst    (InvokeInst &II) {
 531     visitCallSite(&II);
 532     visitTerminatorInst(II);
 533   }
 534   void visitCallSite      (CallSite CS);
 535   void visitUnwindInst    (TerminatorInst &I) { /*returns void*/ }
 536   void visitUnreachableInst(TerminatorInst &I) { /*returns void*/ }
 537   void visitAllocaInst    (Instruction &I) { markOverdefined(&I); }
 538   void visitVAArgInst     (Instruction &I) { markAnythingOverdefined(&I); }
 539
 540   void visitInstruction(Instruction &I) {
 541     // If a new instruction is added to LLVM that we don't handle.
 542     dbgs() << "SCCP: Don't know how to handle: " << I;
 543     markAnythingOverdefined(&I);   // Just in case
 544   }
 545 };
 546
 547 } // end anonymous namespace
 548
 549
 550 // getFeasibleSuccessors - Return a vector of booleans to indicate which
 551 // successors are reachable from a given terminator instruction.
 552 //
 553 void SCCPSolver::getFeasibleSuccessors(TerminatorInst &TI,
 554                                        SmallVector<bool, 16> &Succs) {
 555   Succs.resize(TI.getNumSuccessors());
 556   if (BranchInst *BI = dyn_cast<BranchInst>(&TI)) {
 557     if (BI->isUnconditional()) {
 558       Succs[0] = true;
 559       return;
 560     }
 561
 562     LatticeVal BCValue = getValueState(BI->getCondition());
 563     ConstantInt *CI = BCValue.getConstantInt();
 564     if (CI == 0) {
 565       // Overdefined condition variables, and branches on unfoldable constant
 566       // conditions, mean the branch could go either way.
 567       if (!BCValue.isUndefined())
 568         Succs[0] = Succs[1] = true;
 569       return;
 570     }
 571
 572     // Constant condition variables mean the branch can only go a single way.
 573     Succs[CI->isZero()] = true;
 574     return;
 575   }
 576
 577   if (isa<InvokeInst>(TI)) {
 578     // Invoke instructions successors are always executable.
 579     Succs[0] = Succs[1] = true;
 580     return;
 581   }
 582
 583   if (SwitchInst *SI = dyn_cast<SwitchInst>(&TI)) {
 584     LatticeVal SCValue = getValueState(SI->getCondition());
 585     ConstantInt *CI = SCValue.getConstantInt();
 586
 587     if (CI == 0) {   // Overdefined or undefined condition?
 588       // All destinations are executable!
 589       if (!SCValue.isUndefined())
 590         Succs.assign(TI.getNumSuccessors(), true);
 591       return;
 592     }
 593
 594     Succs[SI->findCaseValue(CI)] = true;
 595     return;
 596   }
 597
 598   // TODO: This could be improved if the operand is a [cast of a] BlockAddress.
 599   if (isa<IndirectBrInst>(&TI)) {
 600     // Just mark all destinations executable!
 601     Succs.assign(TI.getNumSuccessors(), true);
 602     return;
 603   }
 604
 605 #ifndef NDEBUG
 606   dbgs() << "Unknown terminator instruction: " << TI << '\n';
 607 #endif
 608   llvm_unreachable("SCCP: Don't know how to handle this terminator!");
 609 }
 610
 611
 612 // isEdgeFeasible - Return true if the control flow edge from the 'From' basic
 613 // block to the 'To' basic block is currently feasible.
 614 //
 615 bool SCCPSolver::isEdgeFeasible(BasicBlock *From, BasicBlock *To) {
 616   assert(BBExecutable.count(To) && "Dest should always be alive!");
 617
 618   // Make sure the source basic block is executable!!
 619   if (!BBExecutable.count(From)) return false;
 620
 621   // Check to make sure this edge itself is actually feasible now.
 622   TerminatorInst *TI = From->getTerminator();
 623   if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
 624     if (BI->isUnconditional())
 625       return true;
 626
 627     LatticeVal BCValue = getValueState(BI->getCondition());
 628
 629     // Overdefined condition variables mean the branch could go either way,
 630     // undef conditions mean that neither edge is feasible yet.
 631     ConstantInt *CI = BCValue.getConstantInt();
 632     if (CI == 0)
 633       return !BCValue.isUndefined();
 634
 635     // Constant condition variables mean the branch can only go a single way.
 636     return BI->getSuccessor(CI->isZero()) == To;
 637   }
 638
 639   // Invoke instructions successors are always executable.
 640   if (isa<InvokeInst>(TI))
 641     return true;
 642
 643   if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
 644     LatticeVal SCValue = getValueState(SI->getCondition());
 645     ConstantInt *CI = SCValue.getConstantInt();
 646
 647     if (CI == 0)
 648       return !SCValue.isUndefined();
 649
 650     // Make sure to skip the "default value" which isn't a value
 651     for (unsigned i = 1, E = SI->getNumSuccessors(); i != E; ++i)
 652       if (SI->getSuccessorValue(i) == CI) // Found the taken branch.
 653         return SI->getSuccessor(i) == To;
 654
 655     // If the constant value is not equal to any of the branches, we must
 656     // execute default branch.
 657     return SI->getDefaultDest() == To;
 658   }
 659
 660   // Just mark all destinations executable!
 661   // TODO: This could be improved if the operand is a [cast of a] BlockAddress.
 662   if (isa<IndirectBrInst>(&TI))
 663     return true;
 664
 665 #ifndef NDEBUG
 666   dbgs() << "Unknown terminator instruction: " << *TI << '\n';
 667 #endif
 668   llvm_unreachable(0);
 669 }
 670
 671 // visit Implementations - Something changed in this instruction, either an
 672 // operand made a transition, or the instruction is newly executable.  Change
 673 // the value type of I to reflect these changes if appropriate.  This method
 674 // makes sure to do the following actions:
 675 //
 676 // 1. If a phi node merges two constants in, and has conflicting value coming
 677 //    from different branches, or if the PHI node merges in an overdefined
 678 //    value, then the PHI node becomes overdefined.
 679 // 2. If a phi node merges only constants in, and they all agree on value, the
 680 //    PHI node becomes a constant value equal to that.
 681 // 3. If V <- x (op) y && isConstant(x) && isConstant(y) V = Constant
 682 // 4. If V <- x (op) y && (isOverdefined(x) || isOverdefined(y)) V = Overdefined
 683 // 5. If V <- MEM or V <- CALL or V <- (unknown) then V = Overdefined
 684 // 6. If a conditional branch has a value that is constant, make the selected
 685 //    destination executable
 686 // 7. If a conditional branch has a value that is overdefined, make all
 687 //    successors executable.
 688 //
 689 void SCCPSolver::visitPHINode(PHINode &PN) {
 690   // If this PN returns a struct, just mark the result overdefined.
 691   // TODO: We could do a lot better than this if code actually uses this.
 692   if (PN.getType()->isStructTy())
 693     return markAnythingOverdefined(&PN);
 694
 695   if (getValueState(&PN).isOverdefined()) {
 696     // There may be instructions using this PHI node that are not overdefined
 697     // themselves.  If so, make sure that they know that the PHI node operand
 698     // changed.
 699     std::multimap<PHINode*, Instruction*>::iterator I, E;
 700     tie(I, E) = UsersOfOverdefinedPHIs.equal_range(&PN);
 701     if (I == E)
 702       return;
 703
 704     SmallVector<Instruction*, 16> Users;
 705     for (; I != E; ++I)
 706       Users.push_back(I->second);
 707     while (!Users.empty())
 708       visit(Users.pop_back_val());
 709     return;  // Quick exit
 710   }
 711
 712   // Super-extra-high-degree PHI nodes are unlikely to ever be marked constant,
 713   // and slow us down a lot.  Just mark them overdefined.
 714   if (PN.getNumIncomingValues() > 64)
 715     return markOverdefined(&PN);
 716
 717   // Look at all of the executable operands of the PHI node.  If any of them
 718   // are overdefined, the PHI becomes overdefined as well.  If they are all
 719   // constant, and they agree with each other, the PHI becomes the identical
 720   // constant.  If they are constant and don't agree, the PHI is overdefined.
 721   // If there are no executable operands, the PHI remains undefined.
 722   //
 723   Constant *OperandVal = 0;
 724   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
 725     LatticeVal IV = getValueState(PN.getIncomingValue(i));
 726     if (IV.isUndefined()) continue;  // Doesn't influence PHI node.
 727
 728     if (!isEdgeFeasible(PN.getIncomingBlock(i), PN.getParent()))
 729       continue;
 730
 731     if (IV.isOverdefined())    // PHI node becomes overdefined!
 732       return markOverdefined(&PN);
 733
 734     if (OperandVal == 0) {   // Grab the first value.
 735       OperandVal = IV.getConstant();
 736       continue;
 737     }
 738
 739     // There is already a reachable operand.  If we conflict with it,
 740     // then the PHI node becomes overdefined.  If we agree with it, we
 741     // can continue on.
 742
 743     // Check to see if there are two different constants merging, if so, the PHI
 744     // node is overdefined.
 745     if (IV.getConstant() != OperandVal)
 746       return markOverdefined(&PN);
 747   }
 748
 749   // If we exited the loop, this means that the PHI node only has constant
 750   // arguments that agree with each other(and OperandVal is the constant) or
 751   // OperandVal is null because there are no defined incoming arguments.  If
 752   // this is the case, the PHI remains undefined.
 753   //
 754   if (OperandVal)
 755     markConstant(&PN, OperandVal);      // Acquire operand value
 756 }
 757
 758
 759
 760
 761 void SCCPSolver::visitReturnInst(ReturnInst &I) {
 762   if (I.getNumOperands() == 0) return;  // ret void
 763
 764   Function *F = I.getParent()->getParent();
 765   Value *ResultOp = I.getOperand(0);
 766
 767   // If we are tracking the return value of this function, merge it in.
 768   if (!TrackedRetVals.empty() && !ResultOp->getType()->isStructTy()) {
 769     DenseMap<Function*, LatticeVal>::iterator TFRVI =
 770       TrackedRetVals.find(F);
 771     if (TFRVI != TrackedRetVals.end()) {
 772       mergeInValue(TFRVI->second, F, getValueState(ResultOp));
 773       return;
 774     }
 775   }
 776
 777   // Handle functions that return multiple values.
 778   if (!TrackedMultipleRetVals.empty()) {
 779     if (const StructType *STy = dyn_cast<StructType>(ResultOp->getType()))
 780       if (MRVFunctionsTracked.count(F))
 781         for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
 782           mergeInValue(TrackedMultipleRetVals[std::make_pair(F, i)], F,
 783                        getStructValueState(ResultOp, i));
 784
 785   }
 786 }
 787
 788 void SCCPSolver::visitTerminatorInst(TerminatorInst &TI) {
 789   SmallVector<bool, 16> SuccFeasible;
 790   getFeasibleSuccessors(TI, SuccFeasible);
 791
 792   BasicBlock *BB = TI.getParent();
 793
 794   // Mark all feasible successors executable.
 795   for (unsigned i = 0, e = SuccFeasible.size(); i != e; ++i)
 796     if (SuccFeasible[i])
 797       markEdgeExecutable(BB, TI.getSuccessor(i));
 798 }
 799
 800 void SCCPSolver::visitCastInst(CastInst &I) {
 801   LatticeVal OpSt = getValueState(I.getOperand(0));
 802   if (OpSt.isOverdefined())          // Inherit overdefinedness of operand
 803     markOverdefined(&I);
 804   else if (OpSt.isConstant())        // Propagate constant value
 805     markConstant(&I, ConstantExpr::getCast(I.getOpcode(),
 806                                            OpSt.getConstant(), I.getType()));
 807 }
 808
 809
 810 void SCCPSolver::visitExtractValueInst(ExtractValueInst &EVI) {
 811   // If this returns a struct, mark all elements over defined, we don't track
 812   // structs in structs.
 813   if (EVI.getType()->isStructTy())
 814     return markAnythingOverdefined(&EVI);
 815
 816   // If this is extracting from more than one level of struct, we don't know.
 817   if (EVI.getNumIndices() != 1)
 818     return markOverdefined(&EVI);
 819
 820   Value *AggVal = EVI.getAggregateOperand();
 821   if (AggVal->getType()->isStructTy()) {
 822     unsigned i = *EVI.idx_begin();
 823     LatticeVal EltVal = getStructValueState(AggVal, i);
 824     mergeInValue(getValueState(&EVI), &EVI, EltVal);
 825   } else {
 826     // Otherwise, must be extracting from an array.
 827     return markOverdefined(&EVI);
 828   }
 829 }
 830
 831 void SCCPSolver::visitInsertValueInst(InsertValueInst &IVI) {
 832   const StructType *STy = dyn_cast<StructType>(IVI.getType());
 833   if (STy == 0)
 834     return markOverdefined(&IVI);
 835
 836   // If this has more than one index, we can't handle it, drive all results to
 837   // undef.
 838   if (IVI.getNumIndices() != 1)
 839     return markAnythingOverdefined(&IVI);
 840
 841   Value *Aggr = IVI.getAggregateOperand();
 842   unsigned Idx = *IVI.idx_begin();
 843
 844   // Compute the result based on what we're inserting.
 845   for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
 846     // This passes through all values that aren't the inserted element.
 847     if (i != Idx) {
 848       LatticeVal EltVal = getStructValueState(Aggr, i);
 849       mergeInValue(getStructValueState(&IVI, i), &IVI, EltVal);
 850       continue;
 851     }
 852
 853     Value *Val = IVI.getInsertedValueOperand();
 854     if (Val->getType()->isStructTy())
 855       // We don't track structs in structs.
 856       markOverdefined(getStructValueState(&IVI, i), &IVI);
 857     else {
 858       LatticeVal InVal = getValueState(Val);
 859       mergeInValue(getStructValueState(&IVI, i), &IVI, InVal);
 860     }
 861   }
 862 }
 863
 864 void SCCPSolver::visitSelectInst(SelectInst &I) {
 865   // If this select returns a struct, just mark the result overdefined.
 866   // TODO: We could do a lot better than this if code actually uses this.
 867   if (I.getType()->isStructTy())
 868     return markAnythingOverdefined(&I);
 869
 870   LatticeVal CondValue = getValueState(I.getCondition());
 871   if (CondValue.isUndefined())
 872     return;
 873
 874   if (ConstantInt *CondCB = CondValue.getConstantInt()) {
 875     Value *OpVal = CondCB->isZero() ? I.getFalseValue() : I.getTrueValue();
 876     mergeInValue(&I, getValueState(OpVal));
 877     return;
 878   }
 879
 880   // Otherwise, the condition is overdefined or a constant we can't evaluate.
 881   // See if we can produce something better than overdefined based on the T/F
 882   // value.
 883   LatticeVal TVal = getValueState(I.getTrueValue());
 884   LatticeVal FVal = getValueState(I.getFalseValue());
 885
 886   // select ?, C, C -> C.
 887   if (TVal.isConstant() && FVal.isConstant() &&
 888       TVal.getConstant() == FVal.getConstant())
 889     return markConstant(&I, FVal.getConstant());
 890
 891   if (TVal.isUndefined())   // select ?, undef, X -> X.
 892     return mergeInValue(&I, FVal);
 893   if (FVal.isUndefined())   // select ?, X, undef -> X.
 894     return mergeInValue(&I, TVal);
 895   markOverdefined(&I);
 896 }
 897
 898 // Handle Binary Operators.
 899 void SCCPSolver::visitBinaryOperator(Instruction &I) {
 900   LatticeVal V1State = getValueState(I.getOperand(0));
 901   LatticeVal V2State = getValueState(I.getOperand(1));
 902
 903   LatticeVal &IV = ValueState[&I];
 904   if (IV.isOverdefined()) return;
 905
 906   if (V1State.isConstant() && V2State.isConstant())
 907     return markConstant(IV, &I,
 908                         ConstantExpr::get(I.getOpcode(), V1State.getConstant(),
 909                                           V2State.getConstant()));
 910
 911   // If something is undef, wait for it to resolve.
 912   if (!V1State.isOverdefined() && !V2State.isOverdefined())
 913     return;
 914
 915   // Otherwise, one of our operands is overdefined.  Try to produce something
 916   // better than overdefined with some tricks.
 917
 918   // If this is an AND or OR with 0 or -1, it doesn't matter that the other
 919   // operand is overdefined.
 920   if (I.getOpcode() == Instruction::And || I.getOpcode() == Instruction::Or) {
 921     LatticeVal *NonOverdefVal = 0;
 922     if (!V1State.isOverdefined())
 923       NonOverdefVal = &V1State;
 924     else if (!V2State.isOverdefined())
 925       NonOverdefVal = &V2State;
 926
 927     if (NonOverdefVal) {
 928       if (NonOverdefVal->isUndefined()) {
 929         // Could annihilate value.
 930         if (I.getOpcode() == Instruction::And)
 931           markConstant(IV, &I, Constant::getNullValue(I.getType()));
 932         else if (const VectorType *PT = dyn_cast<VectorType>(I.getType()))
 933           markConstant(IV, &I, Constant::getAllOnesValue(PT));
 934         else
 935           markConstant(IV, &I,
 936                        Constant::getAllOnesValue(I.getType()));
 937         return;
 938       }
 939
 940       if (I.getOpcode() == Instruction::And) {
 941         // X and 0 = 0
 942         if (NonOverdefVal->getConstant()->isNullValue())
 943           return markConstant(IV, &I, NonOverdefVal->getConstant());
 944       } else {
 945         if (ConstantInt *CI = NonOverdefVal->getConstantInt())
 946           if (CI->isAllOnesValue())     // X or -1 = -1
 947             return markConstant(IV, &I, NonOverdefVal->getConstant());
 948       }
 949     }
 950   }
 951
 952
 953   // If both operands are PHI nodes, it is possible that this instruction has
 954   // a constant value, despite the fact that the PHI node doesn't.  Check for
 955   // this condition now.
 956   if (PHINode *PN1 = dyn_cast<PHINode>(I.getOperand(0)))
 957     if (PHINode *PN2 = dyn_cast<PHINode>(I.getOperand(1)))
 958       if (PN1->getParent() == PN2->getParent()) {
 959         // Since the two PHI nodes are in the same basic block, they must have
 960         // entries for the same predecessors.  Walk the predecessor list, and
 961         // if all of the incoming values are constants, and the result of
 962         // evaluating this expression with all incoming value pairs is the
 963         // same, then this expression is a constant even though the PHI node
 964         // is not a constant!
 965         LatticeVal Result;
 966         for (unsigned i = 0, e = PN1->getNumIncomingValues(); i != e; ++i) {
 967           LatticeVal In1 = getValueState(PN1->getIncomingValue(i));
 968           BasicBlock *InBlock = PN1->getIncomingBlock(i);
 969           LatticeVal In2 =getValueState(PN2->getIncomingValueForBlock(InBlock));
 970
 971           if (In1.isOverdefined() || In2.isOverdefined()) {
 972             Result.markOverdefined();
 973             break;  // Cannot fold this operation over the PHI nodes!
 974           }
 975
 976           if (In1.isConstant() && In2.isConstant()) {
 977             Constant *V = ConstantExpr::get(I.getOpcode(), In1.getConstant(),
 978                                             In2.getConstant());
 979             if (Result.isUndefined())
 980               Result.markConstant(V);
 981             else if (Result.isConstant() && Result.getConstant() != V) {
 982               Result.markOverdefined();
 983               break;
 984             }
 985           }
 986         }
 987
 988         // If we found a constant value here, then we know the instruction is
 989         // constant despite the fact that the PHI nodes are overdefined.
 990         if (Result.isConstant()) {
 991           markConstant(IV, &I, Result.getConstant());
 992           // Remember that this instruction is virtually using the PHI node
 993           // operands.
 994           InsertInOverdefinedPHIs(&I, PN1);
 995           InsertInOverdefinedPHIs(&I, PN2);
 996           return;
 997         }
 998
 999         if (Result.isUndefined())
1000           return;
1001
1002         // Okay, this really is overdefined now.  Since we might have
1003         // speculatively thought that this was not overdefined before, and
1004         // added ourselves to the UsersOfOverdefinedPHIs list for the PHIs,
1005         // make sure to clean out any entries that we put there, for
1006         // efficiency.
1007         RemoveFromOverdefinedPHIs(&I, PN1);
1008         RemoveFromOverdefinedPHIs(&I, PN2);
1009       }
1010
1011   markOverdefined(&I);
1012 }
1013
1014 // Handle ICmpInst instruction.
1015 void SCCPSolver::visitCmpInst(CmpInst &I) {
1016   LatticeVal V1State = getValueState(I.getOperand(0));
1017   LatticeVal V2State = getValueState(I.getOperand(1));
1018
1019   LatticeVal &IV = ValueState[&I];
1020   if (IV.isOverdefined()) return;
1021
1022   if (V1State.isConstant() && V2State.isConstant())
1023     return markConstant(IV, &I, ConstantExpr::getCompare(I.getPredicate(),
1024                                                          V1State.getConstant(),
1025                                                         V2State.getConstant()));
1026
1027   // If operands are still undefined, wait for it to resolve.
1028   if (!V1State.isOverdefined() && !V2State.isOverdefined())
1029     return;
1030
1031   // If something is overdefined, use some tricks to avoid ending up and over
1032   // defined if we can.
1033
1034   // If both operands are PHI nodes, it is possible that this instruction has
1035   // a constant value, despite the fact that the PHI node doesn't.  Check for
1036   // this condition now.
1037   if (PHINode *PN1 = dyn_cast<PHINode>(I.getOperand(0)))
1038     if (PHINode *PN2 = dyn_cast<PHINode>(I.getOperand(1)))
1039       if (PN1->getParent() == PN2->getParent()) {
1040         // Since the two PHI nodes are in the same basic block, they must have
1041         // entries for the same predecessors.  Walk the predecessor list, and
1042         // if all of the incoming values are constants, and the result of
1043         // evaluating this expression with all incoming value pairs is the
1044         // same, then this expression is a constant even though the PHI node
1045         // is not a constant!
1046         LatticeVal Result;
1047         for (unsigned i = 0, e = PN1->getNumIncomingValues(); i != e; ++i) {
1048           LatticeVal In1 = getValueState(PN1->getIncomingValue(i));
1049           BasicBlock *InBlock = PN1->getIncomingBlock(i);
1050           LatticeVal In2 =getValueState(PN2->getIncomingValueForBlock(InBlock));
1051
1052           if (In1.isOverdefined() || In2.isOverdefined()) {
1053             Result.markOverdefined();
1054             break;  // Cannot fold this operation over the PHI nodes!
1055           }
1056
1057           if (In1.isConstant() && In2.isConstant()) {
1058             Constant *V = ConstantExpr::getCompare(I.getPredicate(),
1059                                                    In1.getConstant(),
1060                                                    In2.getConstant());
1061             if (Result.isUndefined())
1062               Result.markConstant(V);
1063             else if (Result.isConstant() && Result.getConstant() != V) {
1064               Result.markOverdefined();
1065               break;
1066             }
1067           }
1068         }
1069
1070         // If we found a constant value here, then we know the instruction is
1071         // constant despite the fact that the PHI nodes are overdefined.
1072         if (Result.isConstant()) {
1073           markConstant(&I, Result.getConstant());
1074           // Remember that this instruction is virtually using the PHI node
1075           // operands.
1076           InsertInOverdefinedPHIs(&I, PN1);
1077           InsertInOverdefinedPHIs(&I, PN2);
1078           return;
1079         }
1080
1081         if (Result.isUndefined())
1082           return;
1083
1084         // Okay, this really is overdefined now.  Since we might have
1085         // speculatively thought that this was not overdefined before, and
1086         // added ourselves to the UsersOfOverdefinedPHIs list for the PHIs,
1087         // make sure to clean out any entries that we put there, for
1088         // efficiency.
1089         RemoveFromOverdefinedPHIs(&I, PN1);
1090         RemoveFromOverdefinedPHIs(&I, PN2);
1091       }
1092
1093   markOverdefined(&I);
1094 }
1095
1096 void SCCPSolver::visitExtractElementInst(ExtractElementInst &I) {
1097   // TODO : SCCP does not handle vectors properly.
1098   return markOverdefined(&I);
1099
1100 #if 0
1101   LatticeVal &ValState = getValueState(I.getOperand(0));
1102   LatticeVal &IdxState = getValueState(I.getOperand(1));
1103
1104   if (ValState.isOverdefined() || IdxState.isOverdefined())
1105     markOverdefined(&I);
1106   else if(ValState.isConstant() && IdxState.isConstant())
1107     markConstant(&I, ConstantExpr::getExtractElement(ValState.getConstant(),
1108                                                      IdxState.getConstant()));
1109 #endif
1110 }
1111
1112 void SCCPSolver::visitInsertElementInst(InsertElementInst &I) {
1113   // TODO : SCCP does not handle vectors properly.
1114   return markOverdefined(&I);
1115 #if 0
1116   LatticeVal &ValState = getValueState(I.getOperand(0));
1117   LatticeVal &EltState = getValueState(I.getOperand(1));
1118   LatticeVal &IdxState = getValueState(I.getOperand(2));
1119
1120   if (ValState.isOverdefined() || EltState.isOverdefined() ||
1121       IdxState.isOverdefined())
1122     markOverdefined(&I);
1123   else if(ValState.isConstant() && EltState.isConstant() &&
1124           IdxState.isConstant())
1125     markConstant(&I, ConstantExpr::getInsertElement(ValState.getConstant(),
1126                                                     EltState.getConstant(),
1127                                                     IdxState.getConstant()));
1128   else if (ValState.isUndefined() && EltState.isConstant() &&
1129            IdxState.isConstant())
1130     markConstant(&I,ConstantExpr::getInsertElement(UndefValue::get(I.getType()),
1131                                                    EltState.getConstant(),
1132                                                    IdxState.getConstant()));
1133 #endif
1134 }
1135
1136 void SCCPSolver::visitShuffleVectorInst(ShuffleVectorInst &I) {
1137   // TODO : SCCP does not handle vectors properly.
1138   return markOverdefined(&I);
1139 #if 0
1140   LatticeVal &V1State   = getValueState(I.getOperand(0));
1141   LatticeVal &V2State   = getValueState(I.getOperand(1));
1142   LatticeVal &MaskState = getValueState(I.getOperand(2));
1143
1144   if (MaskState.isUndefined() ||
1145       (V1State.isUndefined() && V2State.isUndefined()))
1146     return;  // Undefined output if mask or both inputs undefined.
1147
1148   if (V1State.isOverdefined() || V2State.isOverdefined() ||
1149       MaskState.isOverdefined()) {
1150     markOverdefined(&I);
1151   } else {
1152     // A mix of constant/undef inputs.
1153     Constant *V1 = V1State.isConstant() ?
1154         V1State.getConstant() : UndefValue::get(I.getType());
1155     Constant *V2 = V2State.isConstant() ?
1156         V2State.getConstant() : UndefValue::get(I.getType());
1157     Constant *Mask = MaskState.isConstant() ?
1158       MaskState.getConstant() : UndefValue::get(I.getOperand(2)->getType());
1159     markConstant(&I, ConstantExpr::getShuffleVector(V1, V2, Mask));
1160   }
1161 #endif
1162 }
1163
1164 // Handle getelementptr instructions.  If all operands are constants then we
1165 // can turn this into a getelementptr ConstantExpr.
1166 //
1167 void SCCPSolver::visitGetElementPtrInst(GetElementPtrInst &I) {
1168   if (ValueState[&I].isOverdefined()) return;
1169
1170   SmallVector<Constant*, 8> Operands;
1171   Operands.reserve(I.getNumOperands());
1172
1173   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1174     LatticeVal State = getValueState(I.getOperand(i));
1175     if (State.isUndefined())
1176       return;  // Operands are not resolved yet.
1177
1178     if (State.isOverdefined())
1179       return markOverdefined(&I);
1180
1181     assert(State.isConstant() && "Unknown state!");
1182     Operands.push_back(State.getConstant());
1183   }
1184
1185   Constant *Ptr = Operands[0];
1186   markConstant(&I, ConstantExpr::getGetElementPtr(Ptr, &Operands[0]+1,
1187                                                   Operands.size()-1));
1188 }
1189
1190 void SCCPSolver::visitStoreInst(StoreInst &SI) {
1191   // If this store is of a struct, ignore it.
1192   if (SI.getOperand(0)->getType()->isStructTy())
1193     return;
1194
1195   if (TrackedGlobals.empty() || !isa<GlobalVariable>(SI.getOperand(1)))
1196     return;
1197
1198   GlobalVariable *GV = cast<GlobalVariable>(SI.getOperand(1));
1199   DenseMap<GlobalVariable*, LatticeVal>::iterator I = TrackedGlobals.find(GV);
1200   if (I == TrackedGlobals.end() || I->second.isOverdefined()) return;
1201
1202   // Get the value we are storing into the global, then merge it.
1203   mergeInValue(I->second, GV, getValueState(SI.getOperand(0)));
1204   if (I->second.isOverdefined())
1205     TrackedGlobals.erase(I);      // No need to keep tracking this!
1206 }
1207
1208
1209 // Handle load instructions.  If the operand is a constant pointer to a constant
1210 // global, we can replace the load with the loaded constant value!
1211 void SCCPSolver::visitLoadInst(LoadInst &I) {
1212   // If this load is of a struct, just mark the result overdefined.
1213   if (I.getType()->isStructTy())
1214     return markAnythingOverdefined(&I);
1215
1216   LatticeVal PtrVal = getValueState(I.getOperand(0));
1217   if (PtrVal.isUndefined()) return;   // The pointer is not resolved yet!
1218
1219   LatticeVal &IV = ValueState[&I];
1220   if (IV.isOverdefined()) return;
1221
1222   if (!PtrVal.isConstant() || I.isVolatile())
1223     return markOverdefined(IV, &I);
1224
1225   Constant *Ptr = PtrVal.getConstant();
1226
1227   // load null -> null
1228   if (isa<ConstantPointerNull>(Ptr) && I.getPointerAddressSpace() == 0)
1229     return markConstant(IV, &I, Constant::getNullValue(I.getType()));
1230
1231   // Transform load (constant global) into the value loaded.
1232   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Ptr)) {
1233     if (!TrackedGlobals.empty()) {
1234       // If we are tracking this global, merge in the known value for it.
1235       DenseMap<GlobalVariable*, LatticeVal>::iterator It =
1236         TrackedGlobals.find(GV);
1237       if (It != TrackedGlobals.end()) {
1238         mergeInValue(IV, &I, It->second);
1239         return;
1240       }
1241     }
1242   }
1243
1244   // Transform load from a constant into a constant if possible.
1245   if (Constant *C = ConstantFoldLoadFromConstPtr(Ptr, TD))
1246     return markConstant(IV, &I, C);
1247
1248   // Otherwise we cannot say for certain what value this load will produce.
1249   // Bail out.
1250   markOverdefined(IV, &I);
1251 }
1252
1253 void SCCPSolver::visitCallSite(CallSite CS) {
1254   Function *F = CS.getCalledFunction();
1255   Instruction *I = CS.getInstruction();
1256
1257   // The common case is that we aren't tracking the callee, either because we
1258   // are not doing interprocedural analysis or the callee is indirect, or is
1259   // external.  Handle these cases first.
1260   if (F == 0 || F->isDeclaration()) {
1261 CallOverdefined:
1262     // Void return and not tracking callee, just bail.
1263     if (I->getType()->isVoidTy()) return;
1264
1265     // Otherwise, if we have a single return value case, and if the function is
1266     // a declaration, maybe we can constant fold it.
1267     if (F && F->isDeclaration() && !I->getType()->isStructTy() &&
1268         canConstantFoldCallTo(F)) {
1269
1270       SmallVector<Constant*, 8> Operands;
1271       for (CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
1272            AI != E; ++AI) {
1273         LatticeVal State = getValueState(*AI);
1274
1275         if (State.isUndefined())
1276           return;  // Operands are not resolved yet.
1277         if (State.isOverdefined())
1278           return markOverdefined(I);
1279         assert(State.isConstant() && "Unknown state!");
1280         Operands.push_back(State.getConstant());
1281       }
1282
1283       // If we can constant fold this, mark the result of the call as a
1284       // constant.
1285       if (Constant *C = ConstantFoldCall(F, Operands.data(), Operands.size()))
1286         return markConstant(I, C);
1287     }
1288
1289     // Otherwise, we don't know anything about this call, mark it overdefined.
1290     return markAnythingOverdefined(I);
1291   }
1292
1293   // If this is a local function that doesn't have its address taken, mark its
1294   // entry block executable and merge in the actual arguments to the call into
1295   // the formal arguments of the function.
1296   if (!TrackingIncomingArguments.empty() && TrackingIncomingArguments.count(F)){
1297     MarkBlockExecutable(F->begin());
1298
1299     // Propagate information from this call site into the callee.
1300     CallSite::arg_iterator CAI = CS.arg_begin();
1301     for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
1302          AI != E; ++AI, ++CAI) {
1303       // If this argument is byval, and if the function is not readonly, there
1304       // will be an implicit copy formed of the input aggregate.
1305       if (AI->hasByValAttr() && !F->onlyReadsMemory()) {
1306         markOverdefined(AI);
1307         continue;
1308       }
1309
1310       if (const StructType *STy = dyn_cast<StructType>(AI->getType())) {
1311         for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1312           LatticeVal CallArg = getStructValueState(*CAI, i);
1313           mergeInValue(getStructValueState(AI, i), AI, CallArg);
1314         }
1315       } else {
1316         mergeInValue(AI, getValueState(*CAI));
1317       }
1318     }
1319   }
1320
1321   // If this is a single/zero retval case, see if we're tracking the function.
1322   if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
1323     if (!MRVFunctionsTracked.count(F))
1324       goto CallOverdefined;  // Not tracking this callee.
1325
1326     // If we are tracking this callee, propagate the result of the function
1327     // into this call site.
1328     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
1329       mergeInValue(getStructValueState(I, i), I,
1330                    TrackedMultipleRetVals[std::make_pair(F, i)]);
1331   } else {
1332     DenseMap<Function*, LatticeVal>::iterator TFRVI = TrackedRetVals.find(F);
1333     if (TFRVI == TrackedRetVals.end())
1334       goto CallOverdefined;  // Not tracking this callee.
1335
1336     // If so, propagate the return value of the callee into this call result.
1337     mergeInValue(I, TFRVI->second);
1338   }
1339 }
1340
1341 void SCCPSolver::Solve() {
1342   // Process the work lists until they are empty!
1343   while (!BBWorkList.empty() || !InstWorkList.empty() ||
1344          !OverdefinedInstWorkList.empty()) {
1345     // Process the overdefined instruction's work list first, which drives other
1346     // things to overdefined more quickly.
1347     while (!OverdefinedInstWorkList.empty()) {
1348       Value *I = OverdefinedInstWorkList.pop_back_val();
1349
1350       DEBUG(dbgs() << "\nPopped off OI-WL: " << *I << '\n');
1351
1352       // "I" got into the work list because it either made the transition from
1353       // bottom to constant
1354       //
1355       // Anything on this worklist that is overdefined need not be visited
1356       // since all of its users will have already been marked as overdefined
1357       // Update all of the users of this instruction's value.
1358       //
1359       for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1360            UI != E; ++UI)
1361         if (Instruction *I = dyn_cast<Instruction>(*UI))
1362           OperandChangedState(I);
1363     }
1364
1365     // Process the instruction work list.
1366     while (!InstWorkList.empty()) {
1367       Value *I = InstWorkList.pop_back_val();
1368
1369       DEBUG(dbgs() << "\nPopped off I-WL: " << *I << '\n');
1370
1371       // "I" got into the work list because it made the transition from undef to
1372       // constant.
1373       //
1374       // Anything on this worklist that is overdefined need not be visited
1375       // since all of its users will have already been marked as overdefined.
1376       // Update all of the users of this instruction's value.
1377       //
1378       if (I->getType()->isStructTy() || !getValueState(I).isOverdefined())
1379         for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1380              UI != E; ++UI)
1381           if (Instruction *I = dyn_cast<Instruction>(*UI))
1382             OperandChangedState(I);
1383     }
1384
1385     // Process the basic block work list.
1386     while (!BBWorkList.empty()) {
1387       BasicBlock *BB = BBWorkList.back();
1388       BBWorkList.pop_back();
1389
1390       DEBUG(dbgs() << "\nPopped off BBWL: " << *BB << '\n');
1391
1392       // Notify all instructions in this basic block that they are newly
1393       // executable.
1394       visit(BB);
1395     }
1396   }
1397 }
1398
1399 /// ResolvedUndefsIn - While solving the dataflow for a function, we assume
1400 /// that branches on undef values cannot reach any of their successors.
1401 /// However, this is not a safe assumption.  After we solve dataflow, this
1402 /// method should be use to handle this.  If this returns true, the solver
1403 /// should be rerun.
1404 ///
1405 /// This method handles this by finding an unresolved branch and marking it one
1406 /// of the edges from the block as being feasible, even though the condition
1407 /// doesn't say it would otherwise be.  This allows SCCP to find the rest of the
1408 /// CFG and only slightly pessimizes the analysis results (by marking one,
1409 /// potentially infeasible, edge feasible).  This cannot usefully modify the
1410 /// constraints on the condition of the branch, as that would impact other users
1411 /// of the value.
1412 ///
1413 /// This scan also checks for values that use undefs, whose results are actually
1414 /// defined.  For example, 'zext i8 undef to i32' should produce all zeros
1415 /// conservatively, as "(zext i8 X -> i32) & 0xFF00" must always return zero,
1416 /// even if X isn't defined.
1417 bool SCCPSolver::ResolvedUndefsIn(Function &F) {
1418   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
1419     if (!BBExecutable.count(BB))
1420       continue;
1421
1422     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1423       // Look for instructions which produce undef values.
1424       if (I->getType()->isVoidTy()) continue;
1425
1426       if (const StructType *STy = dyn_cast<StructType>(I->getType())) {
1427         // Only a few things that can be structs matter for undef.  Just send
1428         // all their results to overdefined.  We could be more precise than this
1429         // but it isn't worth bothering.
1430         if (isa<CallInst>(I) || isa<SelectInst>(I)) {
1431           for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1432             LatticeVal &LV = getStructValueState(I, i);
1433             if (LV.isUndefined())
1434               markOverdefined(LV, I);
1435           }
1436         }
1437         continue;
1438       }
1439
1440       LatticeVal &LV = getValueState(I);
1441       if (!LV.isUndefined()) continue;
1442
1443       // No instructions using structs need disambiguation.
1444       if (I->getOperand(0)->getType()->isStructTy())
1445         continue;
1446
1447       // Get the lattice values of the first two operands for use below.
1448       LatticeVal Op0LV = getValueState(I->getOperand(0));
1449       LatticeVal Op1LV;
1450       if (I->getNumOperands() == 2) {
1451         // No instructions using structs need disambiguation.
1452         if (I->getOperand(1)->getType()->isStructTy())
1453           continue;
1454
1455         // If this is a two-operand instruction, and if both operands are
1456         // undefs, the result stays undef.
1457         Op1LV = getValueState(I->getOperand(1));
1458         if (Op0LV.isUndefined() && Op1LV.isUndefined())
1459           continue;
1460       }
1461
1462       // If this is an instructions whose result is defined even if the input is
1463       // not fully defined, propagate the information.
1464       const Type *ITy = I->getType();
1465       switch (I->getOpcode()) {
1466       default: break;          // Leave the instruction as an undef.
1467       case Instruction::ZExt:
1468         // After a zero extend, we know the top part is zero.  SExt doesn't have
1469         // to be handled here, because we don't know whether the top part is 1's
1470         // or 0's.
1471       case Instruction::SIToFP:  // some FP values are not possible, just use 0.
1472       case Instruction::UIToFP:  // some FP values are not possible, just use 0.
1473         markForcedConstant(I, Constant::getNullValue(ITy));
1474         return true;
1475       case Instruction::Mul:
1476       case Instruction::And:
1477         // undef * X -> 0.   X could be zero.
1478         // undef & X -> 0.   X could be zero.
1479         markForcedConstant(I, Constant::getNullValue(ITy));
1480         return true;
1481
1482       case Instruction::Or:
1483         // undef | X -> -1.   X could be -1.
1484         markForcedConstant(I, Constant::getAllOnesValue(ITy));
1485         return true;
1486
1487       case Instruction::SDiv:
1488       case Instruction::UDiv:
1489       case Instruction::SRem:
1490       case Instruction::URem:
1491         // X / undef -> undef.  No change.
1492         // X % undef -> undef.  No change.
1493         if (Op1LV.isUndefined()) break;
1494
1495         // undef / X -> 0.   X could be maxint.
1496         // undef % X -> 0.   X could be 1.
1497         markForcedConstant(I, Constant::getNullValue(ITy));
1498         return true;
1499
1500       case Instruction::AShr:
1501         // undef >>s X -> undef.  No change.
1502         if (Op0LV.isUndefined()) break;
1503
1504         // X >>s undef -> X.  X could be 0, X could have the high-bit known set.
1505         if (Op0LV.isConstant())
1506           markForcedConstant(I, Op0LV.getConstant());
1507         else
1508           markOverdefined(I);
1509         return true;
1510       case Instruction::LShr:
1511       case Instruction::Shl:
1512         // undef >> X -> undef.  No change.
1513         // undef << X -> undef.  No change.
1514         if (Op0LV.isUndefined()) break;
1515
1516         // X >> undef -> 0.  X could be 0.
1517         // X << undef -> 0.  X could be 0.
1518         markForcedConstant(I, Constant::getNullValue(ITy));
1519         return true;
1520       case Instruction::Select:
1521         // undef ? X : Y  -> X or Y.  There could be commonality between X/Y.
1522         if (Op0LV.isUndefined()) {
1523           if (!Op1LV.isConstant())  // Pick the constant one if there is any.
1524             Op1LV = getValueState(I->getOperand(2));
1525         } else if (Op1LV.isUndefined()) {
1526           // c ? undef : undef -> undef.  No change.
1527           Op1LV = getValueState(I->getOperand(2));
1528           if (Op1LV.isUndefined())
1529             break;
1530           // Otherwise, c ? undef : x -> x.
1531         } else {
1532           // Leave Op1LV as Operand(1)'s LatticeValue.
1533         }
1534
1535         if (Op1LV.isConstant())
1536           markForcedConstant(I, Op1LV.getConstant());
1537         else
1538           markOverdefined(I);
1539         return true;
1540       case Instruction::Call:
1541         // If a call has an undef result, it is because it is constant foldable
1542         // but one of the inputs was undef.  Just force the result to
1543         // overdefined.
1544         markOverdefined(I);
1545         return true;
1546       }
1547     }
1548
1549     // Check to see if we have a branch or switch on an undefined value.  If so
1550     // we force the branch to go one way or the other to make the successor
1551     // values live.  It doesn't really matter which way we force it.
1552     TerminatorInst *TI = BB->getTerminator();
1553     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
1554       if (!BI->isConditional()) continue;
1555       if (!getValueState(BI->getCondition()).isUndefined())
1556         continue;
1557
1558       // If the input to SCCP is actually branch on undef, fix the undef to
1559       // false.
1560       if (isa<UndefValue>(BI->getCondition())) {
1561         BI->setCondition(ConstantInt::getFalse(BI->getContext()));
1562         markEdgeExecutable(BB, TI->getSuccessor(1));
1563         return true;
1564       }
1565
1566       // Otherwise, it is a branch on a symbolic value which is currently
1567       // considered to be undef.  Handle this by forcing the input value to the
1568       // branch to false.
1569       markForcedConstant(BI->getCondition(),
1570                          ConstantInt::getFalse(TI->getContext()));
1571       return true;
1572     }
1573
1574     if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
1575       if (SI->getNumSuccessors() < 2)   // no cases
1576         continue;
1577       if (!getValueState(SI->getCondition()).isUndefined())
1578         continue;
1579
1580       // If the input to SCCP is actually switch on undef, fix the undef to
1581       // the first constant.
1582       if (isa<UndefValue>(SI->getCondition())) {
1583         SI->setCondition(SI->getCaseValue(1));
1584         markEdgeExecutable(BB, TI->getSuccessor(1));
1585         return true;
1586       }
1587
1588       markForcedConstant(SI->getCondition(), SI->getCaseValue(1));
1589       return true;
1590     }
1591   }
1592
1593   return false;
1594 }
1595
1596
1597 namespace {
1598   //===--------------------------------------------------------------------===//
1599   //
1600   /// SCCP Class - This class uses the SCCPSolver to implement a per-function
1601   /// Sparse Conditional Constant Propagator.
1602   ///
1603   struct SCCP : public FunctionPass {
1604     static char ID; // Pass identification, replacement for typeid
1605     SCCP() : FunctionPass(ID) {
1606       initializeSCCPPass(*PassRegistry::getPassRegistry());
1607     }
1608
1609     // runOnFunction - Run the Sparse Conditional Constant Propagation
1610     // algorithm, and return true if the function was modified.
1611     //
1612     bool runOnFunction(Function &F);
1613
1614     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
1615       AU.setPreservesCFG();
1616     }
1617   };
1618 } // end anonymous namespace
1619
1620 char SCCP::ID = 0;
1621 INITIALIZE_PASS(SCCP, "sccp",
1622                 "Sparse Conditional Constant Propagation", false, false)
1623
1624 // createSCCPPass - This is the public interface to this file.
1625 FunctionPass *llvm::createSCCPPass() {
1626   return new SCCP();
1627 }
1628
1629 static void DeleteInstructionInBlock(BasicBlock *BB) {
1630   DEBUG(dbgs() << "  BasicBlock Dead:" << *BB);
1631   ++NumDeadBlocks;
1632
1633   // Delete the instructions backwards, as it has a reduced likelihood of
1634   // having to update as many def-use and use-def chains.
1635   while (!isa<TerminatorInst>(BB->begin())) {
1636     Instruction *I = --BasicBlock::iterator(BB->getTerminator());
1637
1638     if (!I->use_empty())
1639       I->replaceAllUsesWith(UndefValue::get(I->getType()));
1640     BB->getInstList().erase(I);
1641     ++NumInstRemoved;
1642   }
1643 }
1644
1645 // runOnFunction() - Run the Sparse Conditional Constant Propagation algorithm,
1646 // and return true if the function was modified.
1647 //
1648 bool SCCP::runOnFunction(Function &F) {
1649   DEBUG(dbgs() << "SCCP on function '" << F.getName() << "'\n");
1650   SCCPSolver Solver(getAnalysisIfAvailable<TargetData>());
1651
1652   // Mark the first block of the function as being executable.
1653   Solver.MarkBlockExecutable(F.begin());
1654
1655   // Mark all arguments to the function as being overdefined.
1656   for (Function::arg_iterator AI = F.arg_begin(), E = F.arg_end(); AI != E;++AI)
1657     Solver.markAnythingOverdefined(AI);
1658
1659   // Solve for constants.
1660   bool ResolvedUndefs = true;
1661   while (ResolvedUndefs) {
1662     Solver.Solve();
1663     DEBUG(dbgs() << "RESOLVING UNDEFs\n");
1664     ResolvedUndefs = Solver.ResolvedUndefsIn(F);
1665   }
1666
1667   bool MadeChanges = false;
1668
1669   // If we decided that there are basic blocks that are dead in this function,
1670   // delete their contents now.  Note that we cannot actually delete the blocks,
1671   // as we cannot modify the CFG of the function.
1672
1673   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
1674     if (!Solver.isBlockExecutable(BB)) {
1675       DeleteInstructionInBlock(BB);
1676       MadeChanges = true;
1677       continue;
1678     }
1679
1680     // Iterate over all of the instructions in a function, replacing them with
1681     // constants if we have found them to be of constant values.
1682     //
1683     for (BasicBlock::iterator BI = BB->begin(), E = BB->end(); BI != E; ) {
1684       Instruction *Inst = BI++;
1685       if (Inst->getType()->isVoidTy() || isa<TerminatorInst>(Inst))
1686         continue;
1687
1688       // TODO: Reconstruct structs from their elements.
1689       if (Inst->getType()->isStructTy())
1690         continue;
1691
1692       LatticeVal IV = Solver.getLatticeValueFor(Inst);
1693       if (IV.isOverdefined())
1694         continue;
1695
1696       Constant *Const = IV.isConstant()
1697         ? IV.getConstant() : UndefValue::get(Inst->getType());
1698       DEBUG(dbgs() << "  Constant: " << *Const << " = " << *Inst);
1699
1700       // Replaces all of the uses of a variable with uses of the constant.
1701       Inst->replaceAllUsesWith(Const);
1702
1703       // Delete the instruction.
1704       Inst->eraseFromParent();
1705
1706       // Hey, we just changed something!
1707       MadeChanges = true;
1708       ++NumInstRemoved;
1709     }
1710   }
1711
1712   return MadeChanges;
1713 }
1714
1715 namespace {
1716   //===--------------------------------------------------------------------===//
1717   //
1718   /// IPSCCP Class - This class implements interprocedural Sparse Conditional
1719   /// Constant Propagation.
1720   ///
1721   struct IPSCCP : public ModulePass {
1722     static char ID;
1723     IPSCCP() : ModulePass(ID) {
1724       initializeIPSCCPPass(*PassRegistry::getPassRegistry());
1725     }
1726     bool runOnModule(Module &M);
1727   };
1728 } // end anonymous namespace
1729
1730 char IPSCCP::ID = 0;
1731 INITIALIZE_PASS(IPSCCP, "ipsccp",
1732                 "Interprocedural Sparse Conditional Constant Propagation",
1733                 false, false)
1734
1735 // createIPSCCPPass - This is the public interface to this file.
1736 ModulePass *llvm::createIPSCCPPass() {
1737   return new IPSCCP();
1738 }
1739
1740
1741 static bool AddressIsTaken(const GlobalValue *GV) {
1742   // Delete any dead constantexpr klingons.
1743   GV->removeDeadConstantUsers();
1744
1745   for (Value::const_use_iterator UI = GV->use_begin(), E = GV->use_end();
1746        UI != E; ++UI) {
1747     const User *U = *UI;
1748     if (const StoreInst *SI = dyn_cast<StoreInst>(U)) {
1749       if (SI->getOperand(0) == GV || SI->isVolatile())
1750         return true;  // Storing addr of GV.
1751     } else if (isa<InvokeInst>(U) || isa<CallInst>(U)) {
1752       // Make sure we are calling the function, not passing the address.
1753       ImmutableCallSite CS(cast<Instruction>(U));
1754       if (!CS.isCallee(UI))
1755         return true;
1756     } else if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
1757       if (LI->isVolatile())
1758         return true;
1759     } else if (isa<BlockAddress>(U)) {
1760       // blockaddress doesn't take the address of the function, it takes addr
1761       // of label.
1762     } else {
1763       return true;
1764     }
1765   }
1766   return false;
1767 }
1768
1769 bool IPSCCP::runOnModule(Module &M) {
1770   SCCPSolver Solver(getAnalysisIfAvailable<TargetData>());
1771
1772   // AddressTakenFunctions - This set keeps track of the address-taken functions
1773   // that are in the input.  As IPSCCP runs through and simplifies code,
1774   // functions that were address taken can end up losing their
1775   // address-taken-ness.  Because of this, we keep track of their addresses from
1776   // the first pass so we can use them for the later simplification pass.
1777   SmallPtrSet<Function*, 32> AddressTakenFunctions;
1778
1779   // Loop over all functions, marking arguments to those with their addresses
1780   // taken or that are external as overdefined.
1781   //
1782   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
1783     if (F->isDeclaration())
1784       continue;
1785
1786     // If this is a strong or ODR definition of this function, then we can
1787     // propagate information about its result into callsites of it.
1788     if (!F->mayBeOverridden())
1789       Solver.AddTrackedFunction(F);
1790
1791     // If this function only has direct calls that we can see, we can track its
1792     // arguments and return value aggressively, and can assume it is not called
1793     // unless we see evidence to the contrary.
1794     if (F->hasLocalLinkage()) {
1795       if (AddressIsTaken(F))
1796         AddressTakenFunctions.insert(F);
1797       else {
1798         Solver.AddArgumentTrackedFunction(F);
1799         continue;
1800       }
1801     }
1802
1803     // Assume the function is called.
1804     Solver.MarkBlockExecutable(F->begin());
1805
1806     // Assume nothing about the incoming arguments.
1807     for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
1808          AI != E; ++AI)
1809       Solver.markAnythingOverdefined(AI);
1810   }
1811
1812   // Loop over global variables.  We inform the solver about any internal global
1813   // variables that do not have their 'addresses taken'.  If they don't have
1814   // their addresses taken, we can propagate constants through them.
1815   for (Module::global_iterator G = M.global_begin(), E = M.global_end();
1816        G != E; ++G)
1817     if (!G->isConstant() && G->hasLocalLinkage() && !AddressIsTaken(G))
1818       Solver.TrackValueOfGlobalVariable(G);
1819
1820   // Solve for constants.
1821   bool ResolvedUndefs = true;
1822   while (ResolvedUndefs) {
1823     Solver.Solve();
1824
1825     DEBUG(dbgs() << "RESOLVING UNDEFS\n");
1826     ResolvedUndefs = false;
1827     for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F)
1828       ResolvedUndefs |= Solver.ResolvedUndefsIn(*F);
1829   }
1830
1831   bool MadeChanges = false;
1832
1833   // Iterate over all of the instructions in the module, replacing them with
1834   // constants if we have found them to be of constant values.
1835   //
1836   SmallVector<BasicBlock*, 512> BlocksToErase;
1837
1838   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
1839     if (Solver.isBlockExecutable(F->begin())) {
1840       for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
1841            AI != E; ++AI) {
1842         if (AI->use_empty() || AI->getType()->isStructTy()) continue;
1843
1844         // TODO: Could use getStructLatticeValueFor to find out if the entire
1845         // result is a constant and replace it entirely if so.
1846
1847         LatticeVal IV = Solver.getLatticeValueFor(AI);
1848         if (IV.isOverdefined()) continue;
1849
1850         Constant *CST = IV.isConstant() ?
1851         IV.getConstant() : UndefValue::get(AI->getType());
1852         DEBUG(dbgs() << "***  Arg " << *AI << " = " << *CST <<"\n");
1853
1854         // Replaces all of the uses of a variable with uses of the
1855         // constant.
1856         AI->replaceAllUsesWith(CST);
1857         ++IPNumArgsElimed;
1858       }
1859     }
1860
1861     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
1862       if (!Solver.isBlockExecutable(BB)) {
1863         DeleteInstructionInBlock(BB);
1864         MadeChanges = true;
1865
1866         TerminatorInst *TI = BB->getTerminator();
1867         for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i) {
1868           BasicBlock *Succ = TI->getSuccessor(i);
1869           if (!Succ->empty() && isa<PHINode>(Succ->begin()))
1870             TI->getSuccessor(i)->removePredecessor(BB);
1871         }
1872         if (!TI->use_empty())
1873           TI->replaceAllUsesWith(UndefValue::get(TI->getType()));
1874         TI->eraseFromParent();
1875
1876         if (&*BB != &F->front())
1877           BlocksToErase.push_back(BB);
1878         else
1879           new UnreachableInst(M.getContext(), BB);
1880         continue;
1881       }
1882
1883       for (BasicBlock::iterator BI = BB->begin(), E = BB->end(); BI != E; ) {
1884         Instruction *Inst = BI++;
1885         if (Inst->getType()->isVoidTy() || Inst->getType()->isStructTy())
1886           continue;
1887
1888         // TODO: Could use getStructLatticeValueFor to find out if the entire
1889         // result is a constant and replace it entirely if so.
1890
1891         LatticeVal IV = Solver.getLatticeValueFor(Inst);
1892         if (IV.isOverdefined())
1893           continue;
1894
1895         Constant *Const = IV.isConstant()
1896           ? IV.getConstant() : UndefValue::get(Inst->getType());
1897         DEBUG(dbgs() << "  Constant: " << *Const << " = " << *Inst);
1898
1899         // Replaces all of the uses of a variable with uses of the
1900         // constant.
1901         Inst->replaceAllUsesWith(Const);
1902
1903         // Delete the instruction.
1904         if (!isa<CallInst>(Inst) && !isa<TerminatorInst>(Inst))
1905           Inst->eraseFromParent();
1906
1907         // Hey, we just changed something!
1908         MadeChanges = true;
1909         ++IPNumInstRemoved;
1910       }
1911     }
1912
1913     // Now that all instructions in the function are constant folded, erase dead
1914     // blocks, because we can now use ConstantFoldTerminator to get rid of
1915     // in-edges.
1916     for (unsigned i = 0, e = BlocksToErase.size(); i != e; ++i) {
1917       // If there are any PHI nodes in this successor, drop entries for BB now.
1918       BasicBlock *DeadBB = BlocksToErase[i];
1919       for (Value::use_iterator UI = DeadBB->use_begin(), UE = DeadBB->use_end();
1920            UI != UE; ) {
1921         // Grab the user and then increment the iterator early, as the user
1922         // will be deleted. Step past all adjacent uses from the same user.
1923         Instruction *I = dyn_cast<Instruction>(*UI);
1924         do { ++UI; } while (UI != UE && *UI == I);
1925
1926         // Ignore blockaddress users; BasicBlock's dtor will handle them.
1927         if (!I) continue;
1928
1929         bool Folded = ConstantFoldTerminator(I->getParent());
1930         if (!Folded) {
1931           // The constant folder may not have been able to fold the terminator
1932           // if this is a branch or switch on undef.  Fold it manually as a
1933           // branch to the first successor.
1934 #ifndef NDEBUG
1935           if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
1936             assert(BI->isConditional() && isa<UndefValue>(BI->getCondition()) &&
1937                    "Branch should be foldable!");
1938           } else if (SwitchInst *SI = dyn_cast<SwitchInst>(I)) {
1939             assert(isa<UndefValue>(SI->getCondition()) && "Switch should fold");
1940           } else {
1941             llvm_unreachable("Didn't fold away reference to block!");
1942           }
1943 #endif
1944
1945           // Make this an uncond branch to the first successor.
1946           TerminatorInst *TI = I->getParent()->getTerminator();
1947           BranchInst::Create(TI->getSuccessor(0), TI);
1948
1949           // Remove entries in successor phi nodes to remove edges.
1950           for (unsigned i = 1, e = TI->getNumSuccessors(); i != e; ++i)
1951             TI->getSuccessor(i)->removePredecessor(TI->getParent());
1952
1953           // Remove the old terminator.
1954           TI->eraseFromParent();
1955         }
1956       }
1957
1958       // Finally, delete the basic block.
1959       F->getBasicBlockList().erase(DeadBB);
1960     }
1961     BlocksToErase.clear();
1962   }
1963
1964   // If we inferred constant or undef return values for a function, we replaced
1965   // all call uses with the inferred value.  This means we don't need to bother
1966   // actually returning anything from the function.  Replace all return
1967   // instructions with return undef.
1968   //
1969   // Do this in two stages: first identify the functions we should process, then
1970   // actually zap their returns.  This is important because we can only do this
1971   // if the address of the function isn't taken.  In cases where a return is the
1972   // last use of a function, the order of processing functions would affect
1973   // whether other functions are optimizable.
1974   SmallVector<ReturnInst*, 8> ReturnsToZap;
1975
1976   // TODO: Process multiple value ret instructions also.
1977   const DenseMap<Function*, LatticeVal> &RV = Solver.getTrackedRetVals();
1978   for (DenseMap<Function*, LatticeVal>::const_iterator I = RV.begin(),
1979        E = RV.end(); I != E; ++I) {
1980     Function *F = I->first;
1981     if (I->second.isOverdefined() || F->getReturnType()->isVoidTy())
1982       continue;
1983
1984     // We can only do this if we know that nothing else can call the function.
1985     if (!F->hasLocalLinkage() || AddressTakenFunctions.count(F))
1986       continue;
1987
1988     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
1989       if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator()))
1990         if (!isa<UndefValue>(RI->getOperand(0)))
1991           ReturnsToZap.push_back(RI);
1992   }
1993
1994   // Zap all returns which we've identified as zap to change.
1995   for (unsigned i = 0, e = ReturnsToZap.size(); i != e; ++i) {
1996     Function *F = ReturnsToZap[i]->getParent()->getParent();
1997     ReturnsToZap[i]->setOperand(0, UndefValue::get(F->getReturnType()));
1998   }
1999
2000   // If we infered constant or undef values for globals variables, we can delete
2001   // the global and any stores that remain to it.
2002   const DenseMap<GlobalVariable*, LatticeVal> &TG = Solver.getTrackedGlobals();
2003   for (DenseMap<GlobalVariable*, LatticeVal>::const_iterator I = TG.begin(),
2004          E = TG.end(); I != E; ++I) {
2005     GlobalVariable *GV = I->first;
2006     assert(!I->second.isOverdefined() &&
2007            "Overdefined values should have been taken out of the map!");
2008     DEBUG(dbgs() << "Found that GV '" << GV->getName() << "' is constant!\n");
2009     while (!GV->use_empty()) {
2010       StoreInst *SI = cast<StoreInst>(GV->use_back());
2011       SI->eraseFromParent();
2012     }
2013     M.getGlobalList().erase(GV);
2014     ++IPNumGlobalConst;
2015   }
2016
2017   return MadeChanges;
2018 }