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