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 private:
 485   friend class InstVisitor<SCCPSolver>;
 486
 487   // visit implementations - Something changed in this instruction.  Either an
 488   // operand made a transition, or the instruction is newly executable.  Change
 489   // the value type of I to reflect these changes if appropriate.
 490   void visitPHINode(PHINode &I);
 491
 492   // Terminators
 493   void visitReturnInst(ReturnInst &I);
 494   void visitTerminatorInst(TerminatorInst &TI);
 495
 496   void visitCastInst(CastInst &I);
 497   void visitSelectInst(SelectInst &I);
 498   void visitBinaryOperator(Instruction &I);
 499   void visitCmpInst(CmpInst &I);
 500   void visitExtractElementInst(ExtractElementInst &I);
 501   void visitInsertElementInst(InsertElementInst &I);
 502   void visitShuffleVectorInst(ShuffleVectorInst &I);
 503   void visitExtractValueInst(ExtractValueInst &EVI);
 504   void visitInsertValueInst(InsertValueInst &IVI);
 505
 506   // Instructions that cannot be folded away.
 507   void visitStoreInst     (StoreInst &I);
 508   void visitLoadInst      (LoadInst &I);
 509   void visitGetElementPtrInst(GetElementPtrInst &I);
 510   void visitCallInst      (CallInst &I) {
 511     visitCallSite(&I);
 512   }
 513   void visitInvokeInst    (InvokeInst &II) {
 514     visitCallSite(&II);
 515     visitTerminatorInst(II);
 516   }
 517   void visitCallSite      (CallSite CS);
 518   void visitUnwindInst    (TerminatorInst &I) { /*returns void*/ }
 519   void visitUnreachableInst(TerminatorInst &I) { /*returns void*/ }
 520   void visitAllocaInst    (Instruction &I) { markOverdefined(&I); }
 521   void visitVANextInst    (Instruction &I) { markOverdefined(&I); }
 522   void visitVAArgInst     (Instruction &I) { markAnythingOverdefined(&I); }
 523
 524   void visitInstruction(Instruction &I) {
 525     // If a new instruction is added to LLVM that we don't handle.
 526     dbgs() << "SCCP: Don't know how to handle: " << I;
 527     markAnythingOverdefined(&I);   // Just in case
 528   }
 529 };
 530
 531 } // end anonymous namespace
 532
 533
 534 // getFeasibleSuccessors - Return a vector of booleans to indicate which
 535 // successors are reachable from a given terminator instruction.
 536 //
 537 void SCCPSolver::getFeasibleSuccessors(TerminatorInst &TI,
 538                                        SmallVector<bool, 16> &Succs) {
 539   Succs.resize(TI.getNumSuccessors());
 540   if (BranchInst *BI = dyn_cast<BranchInst>(&TI)) {
 541     if (BI->isUnconditional()) {
 542       Succs[0] = true;
 543       return;
 544     }
 545
 546     LatticeVal BCValue = getValueState(BI->getCondition());
 547     ConstantInt *CI = BCValue.getConstantInt();
 548     if (CI == 0) {
 549       // Overdefined condition variables, and branches on unfoldable constant
 550       // conditions, mean the branch could go either way.
 551       if (!BCValue.isUndefined())
 552         Succs[0] = Succs[1] = true;
 553       return;
 554     }
 555
 556     // Constant condition variables mean the branch can only go a single way.
 557     Succs[CI->isZero()] = true;
 558     return;
 559   }
 560
 561   if (isa<InvokeInst>(TI)) {
 562     // Invoke instructions successors are always executable.
 563     Succs[0] = Succs[1] = true;
 564     return;
 565   }
 566
 567   if (SwitchInst *SI = dyn_cast<SwitchInst>(&TI)) {
 568     LatticeVal SCValue = getValueState(SI->getCondition());
 569     ConstantInt *CI = SCValue.getConstantInt();
 570
 571     if (CI == 0) {   // Overdefined or undefined condition?
 572       // All destinations are executable!
 573       if (!SCValue.isUndefined())
 574         Succs.assign(TI.getNumSuccessors(), true);
 575       return;
 576     }
 577
 578     Succs[SI->findCaseValue(CI)] = true;
 579     return;
 580   }
 581
 582   // TODO: This could be improved if the operand is a [cast of a] BlockAddress.
 583   if (isa<IndirectBrInst>(&TI)) {
 584     // Just mark all destinations executable!
 585     Succs.assign(TI.getNumSuccessors(), true);
 586     return;
 587   }
 588
 589 #ifndef NDEBUG
 590   dbgs() << "Unknown terminator instruction: " << TI << '\n';
 591 #endif
 592   llvm_unreachable("SCCP: Don't know how to handle this terminator!");
 593 }
 594
 595
 596 // isEdgeFeasible - Return true if the control flow edge from the 'From' basic
 597 // block to the 'To' basic block is currently feasible.
 598 //
 599 bool SCCPSolver::isEdgeFeasible(BasicBlock *From, BasicBlock *To) {
 600   assert(BBExecutable.count(To) && "Dest should always be alive!");
 601
 602   // Make sure the source basic block is executable!!
 603   if (!BBExecutable.count(From)) return false;
 604
 605   // Check to make sure this edge itself is actually feasible now.
 606   TerminatorInst *TI = From->getTerminator();
 607   if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
 608     if (BI->isUnconditional())
 609       return true;
 610
 611     LatticeVal BCValue = getValueState(BI->getCondition());
 612
 613     // Overdefined condition variables mean the branch could go either way,
 614     // undef conditions mean that neither edge is feasible yet.
 615     ConstantInt *CI = BCValue.getConstantInt();
 616     if (CI == 0)
 617       return !BCValue.isUndefined();
 618
 619     // Constant condition variables mean the branch can only go a single way.
 620     return BI->getSuccessor(CI->isZero()) == To;
 621   }
 622
 623   // Invoke instructions successors are always executable.
 624   if (isa<InvokeInst>(TI))
 625     return true;
 626
 627   if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
 628     LatticeVal SCValue = getValueState(SI->getCondition());
 629     ConstantInt *CI = SCValue.getConstantInt();
 630
 631     if (CI == 0)
 632       return !SCValue.isUndefined();
 633
 634     // Make sure to skip the "default value" which isn't a value
 635     for (unsigned i = 1, E = SI->getNumSuccessors(); i != E; ++i)
 636       if (SI->getSuccessorValue(i) == CI) // Found the taken branch.
 637         return SI->getSuccessor(i) == To;
 638
 639     // If the constant value is not equal to any of the branches, we must
 640     // execute default branch.
 641     return SI->getDefaultDest() == To;
 642   }
 643
 644   // Just mark all destinations executable!
 645   // TODO: This could be improved if the operand is a [cast of a] BlockAddress.
 646   if (isa<IndirectBrInst>(&TI))
 647     return true;
 648
 649 #ifndef NDEBUG
 650   dbgs() << "Unknown terminator instruction: " << *TI << '\n';
 651 #endif
 652   llvm_unreachable(0);
 653 }
 654
 655 // visit Implementations - Something changed in this instruction, either an
 656 // operand made a transition, or the instruction is newly executable.  Change
 657 // the value type of I to reflect these changes if appropriate.  This method
 658 // makes sure to do the following actions:
 659 //
 660 // 1. If a phi node merges two constants in, and has conflicting value coming
 661 //    from different branches, or if the PHI node merges in an overdefined
 662 //    value, then the PHI node becomes overdefined.
 663 // 2. If a phi node merges only constants in, and they all agree on value, the
 664 //    PHI node becomes a constant value equal to that.
 665 // 3. If V <- x (op) y && isConstant(x) && isConstant(y) V = Constant
 666 // 4. If V <- x (op) y && (isOverdefined(x) || isOverdefined(y)) V = Overdefined
 667 // 5. If V <- MEM or V <- CALL or V <- (unknown) then V = Overdefined
 668 // 6. If a conditional branch has a value that is constant, make the selected
 669 //    destination executable
 670 // 7. If a conditional branch has a value that is overdefined, make all
 671 //    successors executable.
 672 //
 673 void SCCPSolver::visitPHINode(PHINode &PN) {
 674   // If this PN returns a struct, just mark the result overdefined.
 675   // TODO: We could do a lot better than this if code actually uses this.
 676   if (PN.getType()->isStructTy())
 677     return markAnythingOverdefined(&PN);
 678
 679   if (getValueState(&PN).isOverdefined()) {
 680     // There may be instructions using this PHI node that are not overdefined
 681     // themselves.  If so, make sure that they know that the PHI node operand
 682     // changed.
 683     std::multimap<PHINode*, Instruction*>::iterator I, E;
 684     tie(I, E) = UsersOfOverdefinedPHIs.equal_range(&PN);
 685     if (I == E)
 686       return;
 687
 688     SmallVector<Instruction*, 16> Users;
 689     for (; I != E; ++I)
 690       Users.push_back(I->second);
 691     while (!Users.empty())
 692       visit(Users.pop_back_val());
 693     return;  // Quick exit
 694   }
 695
 696   // Super-extra-high-degree PHI nodes are unlikely to ever be marked constant,
 697   // and slow us down a lot.  Just mark them overdefined.
 698   if (PN.getNumIncomingValues() > 64)
 699     return markOverdefined(&PN);
 700
 701   // Look at all of the executable operands of the PHI node.  If any of them
 702   // are overdefined, the PHI becomes overdefined as well.  If they are all
 703   // constant, and they agree with each other, the PHI becomes the identical
 704   // constant.  If they are constant and don't agree, the PHI is overdefined.
 705   // If there are no executable operands, the PHI remains undefined.
 706   //
 707   Constant *OperandVal = 0;
 708   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
 709     LatticeVal IV = getValueState(PN.getIncomingValue(i));
 710     if (IV.isUndefined()) continue;  // Doesn't influence PHI node.
 711
 712     if (!isEdgeFeasible(PN.getIncomingBlock(i), PN.getParent()))
 713       continue;
 714
 715     if (IV.isOverdefined())    // PHI node becomes overdefined!
 716       return markOverdefined(&PN);
 717
 718     if (OperandVal == 0) {   // Grab the first value.
 719       OperandVal = IV.getConstant();
 720       continue;
 721     }
 722
 723     // There is already a reachable operand.  If we conflict with it,
 724     // then the PHI node becomes overdefined.  If we agree with it, we
 725     // can continue on.
 726
 727     // Check to see if there are two different constants merging, if so, the PHI
 728     // node is overdefined.
 729     if (IV.getConstant() != OperandVal)
 730       return markOverdefined(&PN);
 731   }
 732
 733   // If we exited the loop, this means that the PHI node only has constant
 734   // arguments that agree with each other(and OperandVal is the constant) or
 735   // OperandVal is null because there are no defined incoming arguments.  If
 736   // this is the case, the PHI remains undefined.
 737   //
 738   if (OperandVal)
 739     markConstant(&PN, OperandVal);      // Acquire operand value
 740 }
 741
 742
 743
 744
 745 void SCCPSolver::visitReturnInst(ReturnInst &I) {
 746   if (I.getNumOperands() == 0) return;  // ret void
 747
 748   Function *F = I.getParent()->getParent();
 749   Value *ResultOp = I.getOperand(0);
 750
 751   // If we are tracking the return value of this function, merge it in.
 752   if (!TrackedRetVals.empty() && !ResultOp->getType()->isStructTy()) {
 753     DenseMap<Function*, LatticeVal>::iterator TFRVI =
 754       TrackedRetVals.find(F);
 755     if (TFRVI != TrackedRetVals.end()) {
 756       mergeInValue(TFRVI->second, F, getValueState(ResultOp));
 757       return;
 758     }
 759   }
 760
 761   // Handle functions that return multiple values.
 762   if (!TrackedMultipleRetVals.empty()) {
 763     if (const StructType *STy = dyn_cast<StructType>(ResultOp->getType()))
 764       if (MRVFunctionsTracked.count(F))
 765         for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
 766           mergeInValue(TrackedMultipleRetVals[std::make_pair(F, i)], F,
 767                        getStructValueState(ResultOp, i));
 768
 769   }
 770 }
 771
 772 void SCCPSolver::visitTerminatorInst(TerminatorInst &TI) {
 773   SmallVector<bool, 16> SuccFeasible;
 774   getFeasibleSuccessors(TI, SuccFeasible);
 775
 776   BasicBlock *BB = TI.getParent();
 777
 778   // Mark all feasible successors executable.
 779   for (unsigned i = 0, e = SuccFeasible.size(); i != e; ++i)
 780     if (SuccFeasible[i])
 781       markEdgeExecutable(BB, TI.getSuccessor(i));
 782 }
 783
 784 void SCCPSolver::visitCastInst(CastInst &I) {
 785   LatticeVal OpSt = getValueState(I.getOperand(0));
 786   if (OpSt.isOverdefined())          // Inherit overdefinedness of operand
 787     markOverdefined(&I);
 788   else if (OpSt.isConstant())        // Propagate constant value
 789     markConstant(&I, ConstantExpr::getCast(I.getOpcode(),
 790                                            OpSt.getConstant(), I.getType()));
 791 }
 792
 793
 794 void SCCPSolver::visitExtractValueInst(ExtractValueInst &EVI) {
 795   // If this returns a struct, mark all elements over defined, we don't track
 796   // structs in structs.
 797   if (EVI.getType()->isStructTy())
 798     return markAnythingOverdefined(&EVI);
 799
 800   // If this is extracting from more than one level of struct, we don't know.
 801   if (EVI.getNumIndices() != 1)
 802     return markOverdefined(&EVI);
 803
 804   Value *AggVal = EVI.getAggregateOperand();
 805   if (AggVal->getType()->isStructTy()) {
 806     unsigned i = *EVI.idx_begin();
 807     LatticeVal EltVal = getStructValueState(AggVal, i);
 808     mergeInValue(getValueState(&EVI), &EVI, EltVal);
 809   } else {
 810     // Otherwise, must be extracting from an array.
 811     return markOverdefined(&EVI);
 812   }
 813 }
 814
 815 void SCCPSolver::visitInsertValueInst(InsertValueInst &IVI) {
 816   const StructType *STy = dyn_cast<StructType>(IVI.getType());
 817   if (STy == 0)
 818     return markOverdefined(&IVI);
 819
 820   // If this has more than one index, we can't handle it, drive all results to
 821   // undef.
 822   if (IVI.getNumIndices() != 1)
 823     return markAnythingOverdefined(&IVI);
 824
 825   Value *Aggr = IVI.getAggregateOperand();
 826   unsigned Idx = *IVI.idx_begin();
 827
 828   // Compute the result based on what we're inserting.
 829   for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
 830     // This passes through all values that aren't the inserted element.
 831     if (i != Idx) {
 832       LatticeVal EltVal = getStructValueState(Aggr, i);
 833       mergeInValue(getStructValueState(&IVI, i), &IVI, EltVal);
 834       continue;
 835     }
 836
 837     Value *Val = IVI.getInsertedValueOperand();
 838     if (Val->getType()->isStructTy())
 839       // We don't track structs in structs.
 840       markOverdefined(getStructValueState(&IVI, i), &IVI);
 841     else {
 842       LatticeVal InVal = getValueState(Val);
 843       mergeInValue(getStructValueState(&IVI, i), &IVI, InVal);
 844     }
 845   }
 846 }
 847
 848 void SCCPSolver::visitSelectInst(SelectInst &I) {
 849   // If this select returns a struct, just mark the result overdefined.
 850   // TODO: We could do a lot better than this if code actually uses this.
 851   if (I.getType()->isStructTy())
 852     return markAnythingOverdefined(&I);
 853
 854   LatticeVal CondValue = getValueState(I.getCondition());
 855   if (CondValue.isUndefined())
 856     return;
 857
 858   if (ConstantInt *CondCB = CondValue.getConstantInt()) {
 859     Value *OpVal = CondCB->isZero() ? I.getFalseValue() : I.getTrueValue();
 860     mergeInValue(&I, getValueState(OpVal));
 861     return;
 862   }
 863
 864   // Otherwise, the condition is overdefined or a constant we can't evaluate.
 865   // See if we can produce something better than overdefined based on the T/F
 866   // value.
 867   LatticeVal TVal = getValueState(I.getTrueValue());
 868   LatticeVal FVal = getValueState(I.getFalseValue());
 869
 870   // select ?, C, C -> C.
 871   if (TVal.isConstant() && FVal.isConstant() &&
 872       TVal.getConstant() == FVal.getConstant())
 873     return markConstant(&I, FVal.getConstant());
 874
 875   if (TVal.isUndefined())   // select ?, undef, X -> X.
 876     return mergeInValue(&I, FVal);
 877   if (FVal.isUndefined())   // select ?, X, undef -> X.
 878     return mergeInValue(&I, TVal);
 879   markOverdefined(&I);
 880 }
 881
 882 // Handle Binary Operators.
 883 void SCCPSolver::visitBinaryOperator(Instruction &I) {
 884   LatticeVal V1State = getValueState(I.getOperand(0));
 885   LatticeVal V2State = getValueState(I.getOperand(1));
 886
 887   LatticeVal &IV = ValueState[&I];
 888   if (IV.isOverdefined()) return;
 889
 890   if (V1State.isConstant() && V2State.isConstant())
 891     return markConstant(IV, &I,
 892                         ConstantExpr::get(I.getOpcode(), V1State.getConstant(),
 893                                           V2State.getConstant()));
 894
 895   // If something is undef, wait for it to resolve.
 896   if (!V1State.isOverdefined() && !V2State.isOverdefined())
 897     return;
 898
 899   // Otherwise, one of our operands is overdefined.  Try to produce something
 900   // better than overdefined with some tricks.
 901
 902   // If this is an AND or OR with 0 or -1, it doesn't matter that the other
 903   // operand is overdefined.
 904   if (I.getOpcode() == Instruction::And || I.getOpcode() == Instruction::Or) {
 905     LatticeVal *NonOverdefVal = 0;
 906     if (!V1State.isOverdefined())
 907       NonOverdefVal = &V1State;
 908     else if (!V2State.isOverdefined())
 909       NonOverdefVal = &V2State;
 910
 911     if (NonOverdefVal) {
 912       if (NonOverdefVal->isUndefined()) {
 913         // Could annihilate value.
 914         if (I.getOpcode() == Instruction::And)
 915           markConstant(IV, &I, Constant::getNullValue(I.getType()));
 916         else if (const VectorType *PT = dyn_cast<VectorType>(I.getType()))
 917           markConstant(IV, &I, Constant::getAllOnesValue(PT));
 918         else
 919           markConstant(IV, &I,
 920                        Constant::getAllOnesValue(I.getType()));
 921         return;
 922       }
 923
 924       if (I.getOpcode() == Instruction::And) {
 925         // X and 0 = 0
 926         if (NonOverdefVal->getConstant()->isNullValue())
 927           return markConstant(IV, &I, NonOverdefVal->getConstant());
 928       } else {
 929         if (ConstantInt *CI = NonOverdefVal->getConstantInt())
 930           if (CI->isAllOnesValue())     // X or -1 = -1
 931             return markConstant(IV, &I, NonOverdefVal->getConstant());
 932       }
 933     }
 934   }
 935
 936
 937   // If both operands are PHI nodes, it is possible that this instruction has
 938   // a constant value, despite the fact that the PHI node doesn't.  Check for
 939   // this condition now.
 940   if (PHINode *PN1 = dyn_cast<PHINode>(I.getOperand(0)))
 941     if (PHINode *PN2 = dyn_cast<PHINode>(I.getOperand(1)))
 942       if (PN1->getParent() == PN2->getParent()) {
 943         // Since the two PHI nodes are in the same basic block, they must have
 944         // entries for the same predecessors.  Walk the predecessor list, and
 945         // if all of the incoming values are constants, and the result of
 946         // evaluating this expression with all incoming value pairs is the
 947         // same, then this expression is a constant even though the PHI node
 948         // is not a constant!
 949         LatticeVal Result;
 950         for (unsigned i = 0, e = PN1->getNumIncomingValues(); i != e; ++i) {
 951           LatticeVal In1 = getValueState(PN1->getIncomingValue(i));
 952           BasicBlock *InBlock = PN1->getIncomingBlock(i);
 953           LatticeVal In2 =getValueState(PN2->getIncomingValueForBlock(InBlock));
 954
 955           if (In1.isOverdefined() || In2.isOverdefined()) {
 956             Result.markOverdefined();
 957             break;  // Cannot fold this operation over the PHI nodes!
 958           }
 959
 960           if (In1.isConstant() && In2.isConstant()) {
 961             Constant *V = ConstantExpr::get(I.getOpcode(), In1.getConstant(),
 962                                             In2.getConstant());
 963             if (Result.isUndefined())
 964               Result.markConstant(V);
 965             else if (Result.isConstant() && Result.getConstant() != V) {
 966               Result.markOverdefined();
 967               break;
 968             }
 969           }
 970         }
 971
 972         // If we found a constant value here, then we know the instruction is
 973         // constant despite the fact that the PHI nodes are overdefined.
 974         if (Result.isConstant()) {
 975           markConstant(IV, &I, Result.getConstant());
 976           // Remember that this instruction is virtually using the PHI node
 977           // operands.
 978           UsersOfOverdefinedPHIs.insert(std::make_pair(PN1, &I));
 979           UsersOfOverdefinedPHIs.insert(std::make_pair(PN2, &I));
 980           return;
 981         }
 982
 983         if (Result.isUndefined())
 984           return;
 985
 986         // Okay, this really is overdefined now.  Since we might have
 987         // speculatively thought that this was not overdefined before, and
 988         // added ourselves to the UsersOfOverdefinedPHIs list for the PHIs,
 989         // make sure to clean out any entries that we put there, for
 990         // efficiency.
 991         RemoveFromOverdefinedPHIs(&I, PN1);
 992         RemoveFromOverdefinedPHIs(&I, PN2);
 993       }
 994
 995   markOverdefined(&I);
 996 }
 997
 998 // Handle ICmpInst instruction.
 999 void SCCPSolver::visitCmpInst(CmpInst &I) {
1000   LatticeVal V1State = getValueState(I.getOperand(0));
1001   LatticeVal V2State = getValueState(I.getOperand(1));
1002
1003   LatticeVal &IV = ValueState[&I];
1004   if (IV.isOverdefined()) return;
1005
1006   if (V1State.isConstant() && V2State.isConstant())
1007     return markConstant(IV, &I, ConstantExpr::getCompare(I.getPredicate(),
1008                                                          V1State.getConstant(),
1009                                                         V2State.getConstant()));
1010
1011   // If operands are still undefined, wait for it to resolve.
1012   if (!V1State.isOverdefined() && !V2State.isOverdefined())
1013     return;
1014
1015   // If something is overdefined, use some tricks to avoid ending up and over
1016   // defined if we can.
1017
1018   // If both operands are PHI nodes, it is possible that this instruction has
1019   // a constant value, despite the fact that the PHI node doesn't.  Check for
1020   // this condition now.
1021   if (PHINode *PN1 = dyn_cast<PHINode>(I.getOperand(0)))
1022     if (PHINode *PN2 = dyn_cast<PHINode>(I.getOperand(1)))
1023       if (PN1->getParent() == PN2->getParent()) {
1024         // Since the two PHI nodes are in the same basic block, they must have
1025         // entries for the same predecessors.  Walk the predecessor list, and
1026         // if all of the incoming values are constants, and the result of
1027         // evaluating this expression with all incoming value pairs is the
1028         // same, then this expression is a constant even though the PHI node
1029         // is not a constant!
1030         LatticeVal Result;
1031         for (unsigned i = 0, e = PN1->getNumIncomingValues(); i != e; ++i) {
1032           LatticeVal In1 = getValueState(PN1->getIncomingValue(i));
1033           BasicBlock *InBlock = PN1->getIncomingBlock(i);
1034           LatticeVal In2 =getValueState(PN2->getIncomingValueForBlock(InBlock));
1035
1036           if (In1.isOverdefined() || In2.isOverdefined()) {
1037             Result.markOverdefined();
1038             break;  // Cannot fold this operation over the PHI nodes!
1039           }
1040
1041           if (In1.isConstant() && In2.isConstant()) {
1042             Constant *V = ConstantExpr::getCompare(I.getPredicate(),
1043                                                    In1.getConstant(),
1044                                                    In2.getConstant());
1045             if (Result.isUndefined())
1046               Result.markConstant(V);
1047             else if (Result.isConstant() && Result.getConstant() != V) {
1048               Result.markOverdefined();
1049               break;
1050             }
1051           }
1052         }
1053
1054         // If we found a constant value here, then we know the instruction is
1055         // constant despite the fact that the PHI nodes are overdefined.
1056         if (Result.isConstant()) {
1057           markConstant(&I, Result.getConstant());
1058           // Remember that this instruction is virtually using the PHI node
1059           // operands.
1060           UsersOfOverdefinedPHIs.insert(std::make_pair(PN1, &I));
1061           UsersOfOverdefinedPHIs.insert(std::make_pair(PN2, &I));
1062           return;
1063         }
1064
1065         if (Result.isUndefined())
1066           return;
1067
1068         // Okay, this really is overdefined now.  Since we might have
1069         // speculatively thought that this was not overdefined before, and
1070         // added ourselves to the UsersOfOverdefinedPHIs list for the PHIs,
1071         // make sure to clean out any entries that we put there, for
1072         // efficiency.
1073         RemoveFromOverdefinedPHIs(&I, PN1);
1074         RemoveFromOverdefinedPHIs(&I, PN2);
1075       }
1076
1077   markOverdefined(&I);
1078 }
1079
1080 void SCCPSolver::visitExtractElementInst(ExtractElementInst &I) {
1081   // TODO : SCCP does not handle vectors properly.
1082   return markOverdefined(&I);
1083
1084 #if 0
1085   LatticeVal &ValState = getValueState(I.getOperand(0));
1086   LatticeVal &IdxState = getValueState(I.getOperand(1));
1087
1088   if (ValState.isOverdefined() || IdxState.isOverdefined())
1089     markOverdefined(&I);
1090   else if(ValState.isConstant() && IdxState.isConstant())
1091     markConstant(&I, ConstantExpr::getExtractElement(ValState.getConstant(),
1092                                                      IdxState.getConstant()));
1093 #endif
1094 }
1095
1096 void SCCPSolver::visitInsertElementInst(InsertElementInst &I) {
1097   // TODO : SCCP does not handle vectors properly.
1098   return markOverdefined(&I);
1099 #if 0
1100   LatticeVal &ValState = getValueState(I.getOperand(0));
1101   LatticeVal &EltState = getValueState(I.getOperand(1));
1102   LatticeVal &IdxState = getValueState(I.getOperand(2));
1103
1104   if (ValState.isOverdefined() || EltState.isOverdefined() ||
1105       IdxState.isOverdefined())
1106     markOverdefined(&I);
1107   else if(ValState.isConstant() && EltState.isConstant() &&
1108           IdxState.isConstant())
1109     markConstant(&I, ConstantExpr::getInsertElement(ValState.getConstant(),
1110                                                     EltState.getConstant(),
1111                                                     IdxState.getConstant()));
1112   else if (ValState.isUndefined() && EltState.isConstant() &&
1113            IdxState.isConstant())
1114     markConstant(&I,ConstantExpr::getInsertElement(UndefValue::get(I.getType()),
1115                                                    EltState.getConstant(),
1116                                                    IdxState.getConstant()));
1117 #endif
1118 }
1119
1120 void SCCPSolver::visitShuffleVectorInst(ShuffleVectorInst &I) {
1121   // TODO : SCCP does not handle vectors properly.
1122   return markOverdefined(&I);
1123 #if 0
1124   LatticeVal &V1State   = getValueState(I.getOperand(0));
1125   LatticeVal &V2State   = getValueState(I.getOperand(1));
1126   LatticeVal &MaskState = getValueState(I.getOperand(2));
1127
1128   if (MaskState.isUndefined() ||
1129       (V1State.isUndefined() && V2State.isUndefined()))
1130     return;  // Undefined output if mask or both inputs undefined.
1131
1132   if (V1State.isOverdefined() || V2State.isOverdefined() ||
1133       MaskState.isOverdefined()) {
1134     markOverdefined(&I);
1135   } else {
1136     // A mix of constant/undef inputs.
1137     Constant *V1 = V1State.isConstant() ?
1138         V1State.getConstant() : UndefValue::get(I.getType());
1139     Constant *V2 = V2State.isConstant() ?
1140         V2State.getConstant() : UndefValue::get(I.getType());
1141     Constant *Mask = MaskState.isConstant() ?
1142       MaskState.getConstant() : UndefValue::get(I.getOperand(2)->getType());
1143     markConstant(&I, ConstantExpr::getShuffleVector(V1, V2, Mask));
1144   }
1145 #endif
1146 }
1147
1148 // Handle getelementptr instructions.  If all operands are constants then we
1149 // can turn this into a getelementptr ConstantExpr.
1150 //
1151 void SCCPSolver::visitGetElementPtrInst(GetElementPtrInst &I) {
1152   if (ValueState[&I].isOverdefined()) return;
1153
1154   SmallVector<Constant*, 8> Operands;
1155   Operands.reserve(I.getNumOperands());
1156
1157   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1158     LatticeVal State = getValueState(I.getOperand(i));
1159     if (State.isUndefined())
1160       return;  // Operands are not resolved yet.
1161
1162     if (State.isOverdefined())
1163       return markOverdefined(&I);
1164
1165     assert(State.isConstant() && "Unknown state!");
1166     Operands.push_back(State.getConstant());
1167   }
1168
1169   Constant *Ptr = Operands[0];
1170   markConstant(&I, ConstantExpr::getGetElementPtr(Ptr, &Operands[0]+1,
1171                                                   Operands.size()-1));
1172 }
1173
1174 void SCCPSolver::visitStoreInst(StoreInst &SI) {
1175   // If this store is of a struct, ignore it.
1176   if (SI.getOperand(0)->getType()->isStructTy())
1177     return;
1178
1179   if (TrackedGlobals.empty() || !isa<GlobalVariable>(SI.getOperand(1)))
1180     return;
1181
1182   GlobalVariable *GV = cast<GlobalVariable>(SI.getOperand(1));
1183   DenseMap<GlobalVariable*, LatticeVal>::iterator I = TrackedGlobals.find(GV);
1184   if (I == TrackedGlobals.end() || I->second.isOverdefined()) return;
1185
1186   // Get the value we are storing into the global, then merge it.
1187   mergeInValue(I->second, GV, getValueState(SI.getOperand(0)));
1188   if (I->second.isOverdefined())
1189     TrackedGlobals.erase(I);      // No need to keep tracking this!
1190 }
1191
1192
1193 // Handle load instructions.  If the operand is a constant pointer to a constant
1194 // global, we can replace the load with the loaded constant value!
1195 void SCCPSolver::visitLoadInst(LoadInst &I) {
1196   // If this load is of a struct, just mark the result overdefined.
1197   if (I.getType()->isStructTy())
1198     return markAnythingOverdefined(&I);
1199
1200   LatticeVal PtrVal = getValueState(I.getOperand(0));
1201   if (PtrVal.isUndefined()) return;   // The pointer is not resolved yet!
1202
1203   LatticeVal &IV = ValueState[&I];
1204   if (IV.isOverdefined()) return;
1205
1206   if (!PtrVal.isConstant() || I.isVolatile())
1207     return markOverdefined(IV, &I);
1208
1209   Constant *Ptr = PtrVal.getConstant();
1210
1211   // load null -> null
1212   if (isa<ConstantPointerNull>(Ptr) && I.getPointerAddressSpace() == 0)
1213     return markConstant(IV, &I, Constant::getNullValue(I.getType()));
1214
1215   // Transform load (constant global) into the value loaded.
1216   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Ptr)) {
1217     if (!TrackedGlobals.empty()) {
1218       // If we are tracking this global, merge in the known value for it.
1219       DenseMap<GlobalVariable*, LatticeVal>::iterator It =
1220         TrackedGlobals.find(GV);
1221       if (It != TrackedGlobals.end()) {
1222         mergeInValue(IV, &I, It->second);
1223         return;
1224       }
1225     }
1226   }
1227
1228   // Transform load from a constant into a constant if possible.
1229   if (Constant *C = ConstantFoldLoadFromConstPtr(Ptr, TD))
1230     return markConstant(IV, &I, C);
1231
1232   // Otherwise we cannot say for certain what value this load will produce.
1233   // Bail out.
1234   markOverdefined(IV, &I);
1235 }
1236
1237 void SCCPSolver::visitCallSite(CallSite CS) {
1238   Function *F = CS.getCalledFunction();
1239   Instruction *I = CS.getInstruction();
1240
1241   // The common case is that we aren't tracking the callee, either because we
1242   // are not doing interprocedural analysis or the callee is indirect, or is
1243   // external.  Handle these cases first.
1244   if (F == 0 || F->isDeclaration()) {
1245 CallOverdefined:
1246     // Void return and not tracking callee, just bail.
1247     if (I->getType()->isVoidTy()) return;
1248
1249     // Otherwise, if we have a single return value case, and if the function is
1250     // a declaration, maybe we can constant fold it.
1251     if (F && F->isDeclaration() && !I->getType()->isStructTy() &&
1252         canConstantFoldCallTo(F)) {
1253
1254       SmallVector<Constant*, 8> Operands;
1255       for (CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
1256            AI != E; ++AI) {
1257         LatticeVal State = getValueState(*AI);
1258
1259         if (State.isUndefined())
1260           return;  // Operands are not resolved yet.
1261         if (State.isOverdefined())
1262           return markOverdefined(I);
1263         assert(State.isConstant() && "Unknown state!");
1264         Operands.push_back(State.getConstant());
1265       }
1266
1267       // If we can constant fold this, mark the result of the call as a
1268       // constant.
1269       if (Constant *C = ConstantFoldCall(F, Operands.data(), Operands.size()))
1270         return markConstant(I, C);
1271     }
1272
1273     // Otherwise, we don't know anything about this call, mark it overdefined.
1274     return markAnythingOverdefined(I);
1275   }
1276
1277   // If this is a local function that doesn't have its address taken, mark its
1278   // entry block executable and merge in the actual arguments to the call into
1279   // the formal arguments of the function.
1280   if (!TrackingIncomingArguments.empty() && TrackingIncomingArguments.count(F)){
1281     MarkBlockExecutable(F->begin());
1282
1283     // Propagate information from this call site into the callee.
1284     CallSite::arg_iterator CAI = CS.arg_begin();
1285     for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
1286          AI != E; ++AI, ++CAI) {
1287       // If this argument is byval, and if the function is not readonly, there
1288       // will be an implicit copy formed of the input aggregate.
1289       if (AI->hasByValAttr() && !F->onlyReadsMemory()) {
1290         markOverdefined(AI);
1291         continue;
1292       }
1293
1294       if (const StructType *STy = dyn_cast<StructType>(AI->getType())) {
1295         for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1296           LatticeVal CallArg = getStructValueState(*CAI, i);
1297           mergeInValue(getStructValueState(AI, i), AI, CallArg);
1298         }
1299       } else {
1300         mergeInValue(AI, getValueState(*CAI));
1301       }
1302     }
1303   }
1304
1305   // If this is a single/zero retval case, see if we're tracking the function.
1306   if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
1307     if (!MRVFunctionsTracked.count(F))
1308       goto CallOverdefined;  // Not tracking this callee.
1309
1310     // If we are tracking this callee, propagate the result of the function
1311     // into this call site.
1312     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
1313       mergeInValue(getStructValueState(I, i), I,
1314                    TrackedMultipleRetVals[std::make_pair(F, i)]);
1315   } else {
1316     DenseMap<Function*, LatticeVal>::iterator TFRVI = TrackedRetVals.find(F);
1317     if (TFRVI == TrackedRetVals.end())
1318       goto CallOverdefined;  // Not tracking this callee.
1319
1320     // If so, propagate the return value of the callee into this call result.
1321     mergeInValue(I, TFRVI->second);
1322   }
1323 }
1324
1325 void SCCPSolver::Solve() {
1326   // Process the work lists until they are empty!
1327   while (!BBWorkList.empty() || !InstWorkList.empty() ||
1328          !OverdefinedInstWorkList.empty()) {
1329     // Process the overdefined instruction's work list first, which drives other
1330     // things to overdefined more quickly.
1331     while (!OverdefinedInstWorkList.empty()) {
1332       Value *I = OverdefinedInstWorkList.pop_back_val();
1333
1334       DEBUG(dbgs() << "\nPopped off OI-WL: " << *I << '\n');
1335
1336       // "I" got into the work list because it either made the transition from
1337       // bottom to constant
1338       //
1339       // Anything on this worklist that is overdefined need not be visited
1340       // since all of its users will have already been marked as overdefined
1341       // Update all of the users of this instruction's value.
1342       //
1343       for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1344            UI != E; ++UI)
1345         if (Instruction *I = dyn_cast<Instruction>(*UI))
1346           OperandChangedState(I);
1347     }
1348
1349     // Process the instruction work list.
1350     while (!InstWorkList.empty()) {
1351       Value *I = InstWorkList.pop_back_val();
1352
1353       DEBUG(dbgs() << "\nPopped off I-WL: " << *I << '\n');
1354
1355       // "I" got into the work list because it made the transition from undef to
1356       // constant.
1357       //
1358       // Anything on this worklist that is overdefined need not be visited
1359       // since all of its users will have already been marked as overdefined.
1360       // Update all of the users of this instruction's value.
1361       //
1362       if (I->getType()->isStructTy() || !getValueState(I).isOverdefined())
1363         for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1364              UI != E; ++UI)
1365           if (Instruction *I = dyn_cast<Instruction>(*UI))
1366             OperandChangedState(I);
1367     }
1368
1369     // Process the basic block work list.
1370     while (!BBWorkList.empty()) {
1371       BasicBlock *BB = BBWorkList.back();
1372       BBWorkList.pop_back();
1373
1374       DEBUG(dbgs() << "\nPopped off BBWL: " << *BB << '\n');
1375
1376       // Notify all instructions in this basic block that they are newly
1377       // executable.
1378       visit(BB);
1379     }
1380   }
1381 }
1382
1383 /// ResolvedUndefsIn - While solving the dataflow for a function, we assume
1384 /// that branches on undef values cannot reach any of their successors.
1385 /// However, this is not a safe assumption.  After we solve dataflow, this
1386 /// method should be use to handle this.  If this returns true, the solver
1387 /// should be rerun.
1388 ///
1389 /// This method handles this by finding an unresolved branch and marking it one
1390 /// of the edges from the block as being feasible, even though the condition
1391 /// doesn't say it would otherwise be.  This allows SCCP to find the rest of the
1392 /// CFG and only slightly pessimizes the analysis results (by marking one,
1393 /// potentially infeasible, edge feasible).  This cannot usefully modify the
1394 /// constraints on the condition of the branch, as that would impact other users
1395 /// of the value.
1396 ///
1397 /// This scan also checks for values that use undefs, whose results are actually
1398 /// defined.  For example, 'zext i8 undef to i32' should produce all zeros
1399 /// conservatively, as "(zext i8 X -> i32) & 0xFF00" must always return zero,
1400 /// even if X isn't defined.
1401 bool SCCPSolver::ResolvedUndefsIn(Function &F) {
1402   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
1403     if (!BBExecutable.count(BB))
1404       continue;
1405
1406     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1407       // Look for instructions which produce undef values.
1408       if (I->getType()->isVoidTy()) continue;
1409
1410       if (const StructType *STy = dyn_cast<StructType>(I->getType())) {
1411         // Only a few things that can be structs matter for undef.  Just send
1412         // all their results to overdefined.  We could be more precise than this
1413         // but it isn't worth bothering.
1414         if (isa<CallInst>(I) || isa<SelectInst>(I)) {
1415           for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1416             LatticeVal &LV = getStructValueState(I, i);
1417             if (LV.isUndefined())
1418               markOverdefined(LV, I);
1419           }
1420         }
1421         continue;
1422       }
1423
1424       LatticeVal &LV = getValueState(I);
1425       if (!LV.isUndefined()) continue;
1426
1427       // No instructions using structs need disambiguation.
1428       if (I->getOperand(0)->getType()->isStructTy())
1429         continue;
1430
1431       // Get the lattice values of the first two operands for use below.
1432       LatticeVal Op0LV = getValueState(I->getOperand(0));
1433       LatticeVal Op1LV;
1434       if (I->getNumOperands() == 2) {
1435         // No instructions using structs need disambiguation.
1436         if (I->getOperand(1)->getType()->isStructTy())
1437           continue;
1438
1439         // If this is a two-operand instruction, and if both operands are
1440         // undefs, the result stays undef.
1441         Op1LV = getValueState(I->getOperand(1));
1442         if (Op0LV.isUndefined() && Op1LV.isUndefined())
1443           continue;
1444       }
1445
1446       // If this is an instructions whose result is defined even if the input is
1447       // not fully defined, propagate the information.
1448       const Type *ITy = I->getType();
1449       switch (I->getOpcode()) {
1450       default: break;          // Leave the instruction as an undef.
1451       case Instruction::ZExt:
1452         // After a zero extend, we know the top part is zero.  SExt doesn't have
1453         // to be handled here, because we don't know whether the top part is 1's
1454         // or 0's.
1455       case Instruction::SIToFP:  // some FP values are not possible, just use 0.
1456       case Instruction::UIToFP:  // some FP values are not possible, just use 0.
1457         markForcedConstant(I, Constant::getNullValue(ITy));
1458         return true;
1459       case Instruction::Mul:
1460       case Instruction::And:
1461         // undef * X -> 0.   X could be zero.
1462         // undef & X -> 0.   X could be zero.
1463         markForcedConstant(I, Constant::getNullValue(ITy));
1464         return true;
1465
1466       case Instruction::Or:
1467         // undef | X -> -1.   X could be -1.
1468         markForcedConstant(I, Constant::getAllOnesValue(ITy));
1469         return true;
1470
1471       case Instruction::SDiv:
1472       case Instruction::UDiv:
1473       case Instruction::SRem:
1474       case Instruction::URem:
1475         // X / undef -> undef.  No change.
1476         // X % undef -> undef.  No change.
1477         if (Op1LV.isUndefined()) break;
1478
1479         // undef / X -> 0.   X could be maxint.
1480         // undef % X -> 0.   X could be 1.
1481         markForcedConstant(I, Constant::getNullValue(ITy));
1482         return true;
1483
1484       case Instruction::AShr:
1485         // undef >>s X -> undef.  No change.
1486         if (Op0LV.isUndefined()) break;
1487
1488         // X >>s undef -> X.  X could be 0, X could have the high-bit known set.
1489         if (Op0LV.isConstant())
1490           markForcedConstant(I, Op0LV.getConstant());
1491         else
1492           markOverdefined(I);
1493         return true;
1494       case Instruction::LShr:
1495       case Instruction::Shl:
1496         // undef >> X -> undef.  No change.
1497         // undef << X -> undef.  No change.
1498         if (Op0LV.isUndefined()) break;
1499
1500         // X >> undef -> 0.  X could be 0.
1501         // X << undef -> 0.  X could be 0.
1502         markForcedConstant(I, Constant::getNullValue(ITy));
1503         return true;
1504       case Instruction::Select:
1505         // undef ? X : Y  -> X or Y.  There could be commonality between X/Y.
1506         if (Op0LV.isUndefined()) {
1507           if (!Op1LV.isConstant())  // Pick the constant one if there is any.
1508             Op1LV = getValueState(I->getOperand(2));
1509         } else if (Op1LV.isUndefined()) {
1510           // c ? undef : undef -> undef.  No change.
1511           Op1LV = getValueState(I->getOperand(2));
1512           if (Op1LV.isUndefined())
1513             break;
1514           // Otherwise, c ? undef : x -> x.
1515         } else {
1516           // Leave Op1LV as Operand(1)'s LatticeValue.
1517         }
1518
1519         if (Op1LV.isConstant())
1520           markForcedConstant(I, Op1LV.getConstant());
1521         else
1522           markOverdefined(I);
1523         return true;
1524       case Instruction::Call:
1525         // If a call has an undef result, it is because it is constant foldable
1526         // but one of the inputs was undef.  Just force the result to
1527         // overdefined.
1528         markOverdefined(I);
1529         return true;
1530       }
1531     }
1532
1533     // Check to see if we have a branch or switch on an undefined value.  If so
1534     // we force the branch to go one way or the other to make the successor
1535     // values live.  It doesn't really matter which way we force it.
1536     TerminatorInst *TI = BB->getTerminator();
1537     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
1538       if (!BI->isConditional()) continue;
1539       if (!getValueState(BI->getCondition()).isUndefined())
1540         continue;
1541
1542       // If the input to SCCP is actually branch on undef, fix the undef to
1543       // false.
1544       if (isa<UndefValue>(BI->getCondition())) {
1545         BI->setCondition(ConstantInt::getFalse(BI->getContext()));
1546         markEdgeExecutable(BB, TI->getSuccessor(1));
1547         return true;
1548       }
1549
1550       // Otherwise, it is a branch on a symbolic value which is currently
1551       // considered to be undef.  Handle this by forcing the input value to the
1552       // branch to false.
1553       markForcedConstant(BI->getCondition(),
1554                          ConstantInt::getFalse(TI->getContext()));
1555       return true;
1556     }
1557
1558     if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
1559       if (SI->getNumSuccessors() < 2)   // no cases
1560         continue;
1561       if (!getValueState(SI->getCondition()).isUndefined())
1562         continue;
1563
1564       // If the input to SCCP is actually switch on undef, fix the undef to
1565       // the first constant.
1566       if (isa<UndefValue>(SI->getCondition())) {
1567         SI->setCondition(SI->getCaseValue(1));
1568         markEdgeExecutable(BB, TI->getSuccessor(1));
1569         return true;
1570       }
1571
1572       markForcedConstant(SI->getCondition(), SI->getCaseValue(1));
1573       return true;
1574     }
1575   }
1576
1577   return false;
1578 }
1579
1580
1581 namespace {
1582   //===--------------------------------------------------------------------===//
1583   //
1584   /// SCCP Class - This class uses the SCCPSolver to implement a per-function
1585   /// Sparse Conditional Constant Propagator.
1586   ///
1587   struct SCCP : public FunctionPass {
1588     static char ID; // Pass identification, replacement for typeid
1589     SCCP() : FunctionPass(&ID) {}
1590
1591     // runOnFunction - Run the Sparse Conditional Constant Propagation
1592     // algorithm, and return true if the function was modified.
1593     //
1594     bool runOnFunction(Function &F);
1595
1596     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
1597       AU.setPreservesCFG();
1598     }
1599   };
1600 } // end anonymous namespace
1601
1602 char SCCP::ID = 0;
1603 INITIALIZE_PASS(SCCP, "sccp",
1604                 "Sparse Conditional Constant Propagation", false, false);
1605
1606 // createSCCPPass - This is the public interface to this file.
1607 FunctionPass *llvm::createSCCPPass() {
1608   return new SCCP();
1609 }
1610
1611 static void DeleteInstructionInBlock(BasicBlock *BB) {
1612   DEBUG(dbgs() << "  BasicBlock Dead:" << *BB);
1613   ++NumDeadBlocks;
1614
1615   // Delete the instructions backwards, as it has a reduced likelihood of
1616   // having to update as many def-use and use-def chains.
1617   while (!isa<TerminatorInst>(BB->begin())) {
1618     Instruction *I = --BasicBlock::iterator(BB->getTerminator());
1619
1620     if (!I->use_empty())
1621       I->replaceAllUsesWith(UndefValue::get(I->getType()));
1622     BB->getInstList().erase(I);
1623     ++NumInstRemoved;
1624   }
1625 }
1626
1627 // runOnFunction() - Run the Sparse Conditional Constant Propagation algorithm,
1628 // and return true if the function was modified.
1629 //
1630 bool SCCP::runOnFunction(Function &F) {
1631   DEBUG(dbgs() << "SCCP on function '" << F.getName() << "'\n");
1632   SCCPSolver Solver(getAnalysisIfAvailable<TargetData>());
1633
1634   // Mark the first block of the function as being executable.
1635   Solver.MarkBlockExecutable(F.begin());
1636
1637   // Mark all arguments to the function as being overdefined.
1638   for (Function::arg_iterator AI = F.arg_begin(), E = F.arg_end(); AI != E;++AI)
1639     Solver.markAnythingOverdefined(AI);
1640
1641   // Solve for constants.
1642   bool ResolvedUndefs = true;
1643   while (ResolvedUndefs) {
1644     Solver.Solve();
1645     DEBUG(dbgs() << "RESOLVING UNDEFs\n");
1646     ResolvedUndefs = Solver.ResolvedUndefsIn(F);
1647   }
1648
1649   bool MadeChanges = false;
1650
1651   // If we decided that there are basic blocks that are dead in this function,
1652   // delete their contents now.  Note that we cannot actually delete the blocks,
1653   // as we cannot modify the CFG of the function.
1654
1655   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
1656     if (!Solver.isBlockExecutable(BB)) {
1657       DeleteInstructionInBlock(BB);
1658       MadeChanges = true;
1659       continue;
1660     }
1661
1662     // Iterate over all of the instructions in a function, replacing them with
1663     // constants if we have found them to be of constant values.
1664     //
1665     for (BasicBlock::iterator BI = BB->begin(), E = BB->end(); BI != E; ) {
1666       Instruction *Inst = BI++;
1667       if (Inst->getType()->isVoidTy() || isa<TerminatorInst>(Inst))
1668         continue;
1669
1670       // TODO: Reconstruct structs from their elements.
1671       if (Inst->getType()->isStructTy())
1672         continue;
1673
1674       LatticeVal IV = Solver.getLatticeValueFor(Inst);
1675       if (IV.isOverdefined())
1676         continue;
1677
1678       Constant *Const = IV.isConstant()
1679         ? IV.getConstant() : UndefValue::get(Inst->getType());
1680       DEBUG(dbgs() << "  Constant: " << *Const << " = " << *Inst);
1681
1682       // Replaces all of the uses of a variable with uses of the constant.
1683       Inst->replaceAllUsesWith(Const);
1684
1685       // Delete the instruction.
1686       Inst->eraseFromParent();
1687
1688       // Hey, we just changed something!
1689       MadeChanges = true;
1690       ++NumInstRemoved;
1691     }
1692   }
1693
1694   return MadeChanges;
1695 }
1696
1697 namespace {
1698   //===--------------------------------------------------------------------===//
1699   //
1700   /// IPSCCP Class - This class implements interprocedural Sparse Conditional
1701   /// Constant Propagation.
1702   ///
1703   struct IPSCCP : public ModulePass {
1704     static char ID;
1705     IPSCCP() : ModulePass(&ID) {}
1706     bool runOnModule(Module &M);
1707   };
1708 } // end anonymous namespace
1709
1710 char IPSCCP::ID = 0;
1711 INITIALIZE_PASS(IPSCCP, "ipsccp",
1712                 "Interprocedural Sparse Conditional Constant Propagation",
1713                 false, false);
1714
1715 // createIPSCCPPass - This is the public interface to this file.
1716 ModulePass *llvm::createIPSCCPPass() {
1717   return new IPSCCP();
1718 }
1719
1720
1721 static bool AddressIsTaken(const GlobalValue *GV) {
1722   // Delete any dead constantexpr klingons.
1723   GV->removeDeadConstantUsers();
1724
1725   for (Value::const_use_iterator UI = GV->use_begin(), E = GV->use_end();
1726        UI != E; ++UI) {
1727     const User *U = *UI;
1728     if (const StoreInst *SI = dyn_cast<StoreInst>(U)) {
1729       if (SI->getOperand(0) == GV || SI->isVolatile())
1730         return true;  // Storing addr of GV.
1731     } else if (isa<InvokeInst>(U) || isa<CallInst>(U)) {
1732       // Make sure we are calling the function, not passing the address.
1733       ImmutableCallSite CS(cast<Instruction>(U));
1734       if (!CS.isCallee(UI))
1735         return true;
1736     } else if (const LoadInst *LI = dyn_cast<LoadInst>(U)) {
1737       if (LI->isVolatile())
1738         return true;
1739     } else if (isa<BlockAddress>(U)) {
1740       // blockaddress doesn't take the address of the function, it takes addr
1741       // of label.
1742     } else {
1743       return true;
1744     }
1745   }
1746   return false;
1747 }
1748
1749 bool IPSCCP::runOnModule(Module &M) {
1750   SCCPSolver Solver(getAnalysisIfAvailable<TargetData>());
1751
1752   // Loop over all functions, marking arguments to those with their addresses
1753   // taken or that are external as overdefined.
1754   //
1755   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
1756     if (F->isDeclaration())
1757       continue;
1758
1759     // If this is a strong or ODR definition of this function, then we can
1760     // propagate information about its result into callsites of it.
1761     if (!F->mayBeOverridden())
1762       Solver.AddTrackedFunction(F);
1763
1764     // If this function only has direct calls that we can see, we can track its
1765     // arguments and return value aggressively, and can assume it is not called
1766     // unless we see evidence to the contrary.
1767     if (F->hasLocalLinkage() && !AddressIsTaken(F)) {
1768       Solver.AddArgumentTrackedFunction(F);
1769       continue;
1770     }
1771
1772     // Assume the function is called.
1773     Solver.MarkBlockExecutable(F->begin());
1774
1775     // Assume nothing about the incoming arguments.
1776     for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
1777          AI != E; ++AI)
1778       Solver.markAnythingOverdefined(AI);
1779   }
1780
1781   // Loop over global variables.  We inform the solver about any internal global
1782   // variables that do not have their 'addresses taken'.  If they don't have
1783   // their addresses taken, we can propagate constants through them.
1784   for (Module::global_iterator G = M.global_begin(), E = M.global_end();
1785        G != E; ++G)
1786     if (!G->isConstant() && G->hasLocalLinkage() && !AddressIsTaken(G))
1787       Solver.TrackValueOfGlobalVariable(G);
1788
1789   // Solve for constants.
1790   bool ResolvedUndefs = true;
1791   while (ResolvedUndefs) {
1792     Solver.Solve();
1793
1794     DEBUG(dbgs() << "RESOLVING UNDEFS\n");
1795     ResolvedUndefs = false;
1796     for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F)
1797       ResolvedUndefs |= Solver.ResolvedUndefsIn(*F);
1798   }
1799
1800   bool MadeChanges = false;
1801
1802   // Iterate over all of the instructions in the module, replacing them with
1803   // constants if we have found them to be of constant values.
1804   //
1805   SmallVector<BasicBlock*, 512> BlocksToErase;
1806
1807   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
1808     if (Solver.isBlockExecutable(F->begin())) {
1809       for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
1810            AI != E; ++AI) {
1811         if (AI->use_empty() || AI->getType()->isStructTy()) continue;
1812
1813         // TODO: Could use getStructLatticeValueFor to find out if the entire
1814         // result is a constant and replace it entirely if so.
1815
1816         LatticeVal IV = Solver.getLatticeValueFor(AI);
1817         if (IV.isOverdefined()) continue;
1818
1819         Constant *CST = IV.isConstant() ?
1820         IV.getConstant() : UndefValue::get(AI->getType());
1821         DEBUG(dbgs() << "***  Arg " << *AI << " = " << *CST <<"\n");
1822
1823         // Replaces all of the uses of a variable with uses of the
1824         // constant.
1825         AI->replaceAllUsesWith(CST);
1826         ++IPNumArgsElimed;
1827       }
1828     }
1829
1830     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
1831       if (!Solver.isBlockExecutable(BB)) {
1832         DeleteInstructionInBlock(BB);
1833         MadeChanges = true;
1834
1835         TerminatorInst *TI = BB->getTerminator();
1836         for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i) {
1837           BasicBlock *Succ = TI->getSuccessor(i);
1838           if (!Succ->empty() && isa<PHINode>(Succ->begin()))
1839             TI->getSuccessor(i)->removePredecessor(BB);
1840         }
1841         if (!TI->use_empty())
1842           TI->replaceAllUsesWith(UndefValue::get(TI->getType()));
1843         TI->eraseFromParent();
1844
1845         if (&*BB != &F->front())
1846           BlocksToErase.push_back(BB);
1847         else
1848           new UnreachableInst(M.getContext(), BB);
1849         continue;
1850       }
1851
1852       for (BasicBlock::iterator BI = BB->begin(), E = BB->end(); BI != E; ) {
1853         Instruction *Inst = BI++;
1854         if (Inst->getType()->isVoidTy() || Inst->getType()->isStructTy())
1855           continue;
1856
1857         // TODO: Could use getStructLatticeValueFor to find out if the entire
1858         // result is a constant and replace it entirely if so.
1859
1860         LatticeVal IV = Solver.getLatticeValueFor(Inst);
1861         if (IV.isOverdefined())
1862           continue;
1863
1864         Constant *Const = IV.isConstant()
1865           ? IV.getConstant() : UndefValue::get(Inst->getType());
1866         DEBUG(dbgs() << "  Constant: " << *Const << " = " << *Inst);
1867
1868         // Replaces all of the uses of a variable with uses of the
1869         // constant.
1870         Inst->replaceAllUsesWith(Const);
1871
1872         // Delete the instruction.
1873         if (!isa<CallInst>(Inst) && !isa<TerminatorInst>(Inst))
1874           Inst->eraseFromParent();
1875
1876         // Hey, we just changed something!
1877         MadeChanges = true;
1878         ++IPNumInstRemoved;
1879       }
1880     }
1881
1882     // Now that all instructions in the function are constant folded, erase dead
1883     // blocks, because we can now use ConstantFoldTerminator to get rid of
1884     // in-edges.
1885     for (unsigned i = 0, e = BlocksToErase.size(); i != e; ++i) {
1886       // If there are any PHI nodes in this successor, drop entries for BB now.
1887       BasicBlock *DeadBB = BlocksToErase[i];
1888       for (Value::use_iterator UI = DeadBB->use_begin(), UE = DeadBB->use_end();
1889            UI != UE; ) {
1890         // Grab the user and then increment the iterator early, as the user
1891         // will be deleted. Step past all adjacent uses from the same user.
1892         Instruction *I = dyn_cast<Instruction>(*UI);
1893         do { ++UI; } while (UI != UE && *UI == I);
1894
1895         // Ignore blockaddress users; BasicBlock's dtor will handle them.
1896         if (!I) continue;
1897
1898         bool Folded = ConstantFoldTerminator(I->getParent());
1899         if (!Folded) {
1900           // The constant folder may not have been able to fold the terminator
1901           // if this is a branch or switch on undef.  Fold it manually as a
1902           // branch to the first successor.
1903 #ifndef NDEBUG
1904           if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
1905             assert(BI->isConditional() && isa<UndefValue>(BI->getCondition()) &&
1906                    "Branch should be foldable!");
1907           } else if (SwitchInst *SI = dyn_cast<SwitchInst>(I)) {
1908             assert(isa<UndefValue>(SI->getCondition()) && "Switch should fold");
1909           } else {
1910             llvm_unreachable("Didn't fold away reference to block!");
1911           }
1912 #endif
1913
1914           // Make this an uncond branch to the first successor.
1915           TerminatorInst *TI = I->getParent()->getTerminator();
1916           BranchInst::Create(TI->getSuccessor(0), TI);
1917
1918           // Remove entries in successor phi nodes to remove edges.
1919           for (unsigned i = 1, e = TI->getNumSuccessors(); i != e; ++i)
1920             TI->getSuccessor(i)->removePredecessor(TI->getParent());
1921
1922           // Remove the old terminator.
1923           TI->eraseFromParent();
1924         }
1925       }
1926
1927       // Finally, delete the basic block.
1928       F->getBasicBlockList().erase(DeadBB);
1929     }
1930     BlocksToErase.clear();
1931   }
1932
1933   // If we inferred constant or undef return values for a function, we replaced
1934   // all call uses with the inferred value.  This means we don't need to bother
1935   // actually returning anything from the function.  Replace all return
1936   // instructions with return undef.
1937   //
1938   // Do this in two stages: first identify the functions we should process, then
1939   // actually zap their returns.  This is important because we can only do this
1940   // if the address of the function isn't taken.  In cases where a return is the
1941   // last use of a function, the order of processing functions would affect
1942   // whether other functions are optimizable.
1943   SmallVector<ReturnInst*, 8> ReturnsToZap;
1944
1945   // TODO: Process multiple value ret instructions also.
1946   const DenseMap<Function*, LatticeVal> &RV = Solver.getTrackedRetVals();
1947   for (DenseMap<Function*, LatticeVal>::const_iterator I = RV.begin(),
1948        E = RV.end(); I != E; ++I) {
1949     Function *F = I->first;
1950     if (I->second.isOverdefined() || F->getReturnType()->isVoidTy())
1951       continue;
1952
1953     // We can only do this if we know that nothing else can call the function.
1954     if (!F->hasLocalLinkage() || AddressIsTaken(F))
1955       continue;
1956
1957     for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
1958       if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator()))
1959         if (!isa<UndefValue>(RI->getOperand(0)))
1960           ReturnsToZap.push_back(RI);
1961   }
1962
1963   // Zap all returns which we've identified as zap to change.
1964   for (unsigned i = 0, e = ReturnsToZap.size(); i != e; ++i) {
1965     Function *F = ReturnsToZap[i]->getParent()->getParent();
1966     ReturnsToZap[i]->setOperand(0, UndefValue::get(F->getReturnType()));
1967   }
1968
1969   // If we infered constant or undef values for globals variables, we can delete
1970   // the global and any stores that remain to it.
1971   const DenseMap<GlobalVariable*, LatticeVal> &TG = Solver.getTrackedGlobals();
1972   for (DenseMap<GlobalVariable*, LatticeVal>::const_iterator I = TG.begin(),
1973          E = TG.end(); I != E; ++I) {
1974     GlobalVariable *GV = I->first;
1975     assert(!I->second.isOverdefined() &&
1976            "Overdefined values should have been taken out of the map!");
1977     DEBUG(dbgs() << "Found that GV '" << GV->getName() << "' is constant!\n");
1978     while (!GV->use_empty()) {
1979       StoreInst *SI = cast<StoreInst>(GV->use_back());
1980       SI->eraseFromParent();
1981     }
1982     M.getGlobalList().erase(GV);
1983     ++IPNumGlobalConst;
1984   }
1985
1986   return MadeChanges;
1987 }