lib/Transforms/Scalar/GVN.cpp

   1 //===- GVN.cpp - Eliminate redundant values and loads ---------------------===//
   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 pass performs global value numbering to eliminate fully redundant
  11 // instructions.  It also performs simple dead load elimination.
  12 //
  13 // Note that this pass does the value numbering itself; it does not use the
  14 // ValueNumbering analysis passes.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #define DEBUG_TYPE "gvn"
  19 #include "llvm/Transforms/Scalar.h"
  20 #include "llvm/BasicBlock.h"
  21 #include "llvm/Constants.h"
  22 #include "llvm/DerivedTypes.h"
  23 #include "llvm/Function.h"
  24 #include "llvm/IntrinsicInst.h"
  25 #include "llvm/LLVMContext.h"
  26 #include "llvm/Value.h"
  27 #include "llvm/ADT/DenseMap.h"
  28 #include "llvm/ADT/DepthFirstIterator.h"
  29 #include "llvm/ADT/PostOrderIterator.h"
  30 #include "llvm/ADT/SmallPtrSet.h"
  31 #include "llvm/ADT/SmallVector.h"
  32 #include "llvm/ADT/Statistic.h"
  33 #include "llvm/Analysis/Dominators.h"
  34 #include "llvm/Analysis/AliasAnalysis.h"
  35 #include "llvm/Analysis/MallocHelper.h"
  36 #include "llvm/Analysis/MemoryDependenceAnalysis.h"
  37 #include "llvm/Support/CFG.h"
  38 #include "llvm/Support/CommandLine.h"
  39 #include "llvm/Support/Debug.h"
  40 #include "llvm/Support/ErrorHandling.h"
  41 #include "llvm/Support/raw_ostream.h"
  42 #include "llvm/Target/TargetData.h"
  43 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  44 #include "llvm/Transforms/Utils/Local.h"
  45 #include <cstdio>
  46 using namespace llvm;
  47
  48 STATISTIC(NumGVNInstr,  "Number of instructions deleted");
  49 STATISTIC(NumGVNLoad,   "Number of loads deleted");
  50 STATISTIC(NumGVNPRE,    "Number of instructions PRE'd");
  51 STATISTIC(NumGVNBlocks, "Number of blocks merged");
  52 STATISTIC(NumPRELoad,   "Number of loads PRE'd");
  53
  54 static cl::opt<bool> EnablePRE("enable-pre",
  55                                cl::init(true), cl::Hidden);
  56 static cl::opt<bool> EnableLoadPRE("enable-load-pre", cl::init(true));
  57
  58 //===----------------------------------------------------------------------===//
  59 //                         ValueTable Class
  60 //===----------------------------------------------------------------------===//
  61
  62 /// This class holds the mapping between values and value numbers.  It is used
  63 /// as an efficient mechanism to determine the expression-wise equivalence of
  64 /// two values.
  65 namespace {
  66   struct Expression {
  67     enum ExpressionOpcode { ADD, FADD, SUB, FSUB, MUL, FMUL,
  68                             UDIV, SDIV, FDIV, UREM, SREM,
  69                             FREM, SHL, LSHR, ASHR, AND, OR, XOR, ICMPEQ,
  70                             ICMPNE, ICMPUGT, ICMPUGE, ICMPULT, ICMPULE,
  71                             ICMPSGT, ICMPSGE, ICMPSLT, ICMPSLE, FCMPOEQ,
  72                             FCMPOGT, FCMPOGE, FCMPOLT, FCMPOLE, FCMPONE,
  73                             FCMPORD, FCMPUNO, FCMPUEQ, FCMPUGT, FCMPUGE,
  74                             FCMPULT, FCMPULE, FCMPUNE, EXTRACT, INSERT,
  75                             SHUFFLE, SELECT, TRUNC, ZEXT, SEXT, FPTOUI,
  76                             FPTOSI, UITOFP, SITOFP, FPTRUNC, FPEXT,
  77                             PTRTOINT, INTTOPTR, BITCAST, GEP, CALL, CONSTANT,
  78                             EMPTY, TOMBSTONE };
  79
  80     ExpressionOpcode opcode;
  81     const Type* type;
  82     uint32_t firstVN;
  83     uint32_t secondVN;
  84     uint32_t thirdVN;
  85     SmallVector<uint32_t, 4> varargs;
  86     Value* function;
  87
  88     Expression() { }
  89     Expression(ExpressionOpcode o) : opcode(o) { }
  90
  91     bool operator==(const Expression &other) const {
  92       if (opcode != other.opcode)
  93         return false;
  94       else if (opcode == EMPTY || opcode == TOMBSTONE)
  95         return true;
  96       else if (type != other.type)
  97         return false;
  98       else if (function != other.function)
  99         return false;
 100       else if (firstVN != other.firstVN)
 101         return false;
 102       else if (secondVN != other.secondVN)
 103         return false;
 104       else if (thirdVN != other.thirdVN)
 105         return false;
 106       else {
 107         if (varargs.size() != other.varargs.size())
 108           return false;
 109
 110         for (size_t i = 0; i < varargs.size(); ++i)
 111           if (varargs[i] != other.varargs[i])
 112             return false;
 113
 114         return true;
 115       }
 116     }
 117
 118     bool operator!=(const Expression &other) const {
 119       return !(*this == other);
 120     }
 121   };
 122
 123   class ValueTable {
 124     private:
 125       DenseMap<Value*, uint32_t> valueNumbering;
 126       DenseMap<Expression, uint32_t> expressionNumbering;
 127       AliasAnalysis* AA;
 128       MemoryDependenceAnalysis* MD;
 129       DominatorTree* DT;
 130
 131       uint32_t nextValueNumber;
 132
 133       Expression::ExpressionOpcode getOpcode(BinaryOperator* BO);
 134       Expression::ExpressionOpcode getOpcode(CmpInst* C);
 135       Expression::ExpressionOpcode getOpcode(CastInst* C);
 136       Expression create_expression(BinaryOperator* BO);
 137       Expression create_expression(CmpInst* C);
 138       Expression create_expression(ShuffleVectorInst* V);
 139       Expression create_expression(ExtractElementInst* C);
 140       Expression create_expression(InsertElementInst* V);
 141       Expression create_expression(SelectInst* V);
 142       Expression create_expression(CastInst* C);
 143       Expression create_expression(GetElementPtrInst* G);
 144       Expression create_expression(CallInst* C);
 145       Expression create_expression(Constant* C);
 146     public:
 147       ValueTable() : nextValueNumber(1) { }
 148       uint32_t lookup_or_add(Value* V);
 149       uint32_t lookup(Value* V) const;
 150       void add(Value* V, uint32_t num);
 151       void clear();
 152       void erase(Value* v);
 153       unsigned size();
 154       void setAliasAnalysis(AliasAnalysis* A) { AA = A; }
 155       AliasAnalysis *getAliasAnalysis() const { return AA; }
 156       void setMemDep(MemoryDependenceAnalysis* M) { MD = M; }
 157       void setDomTree(DominatorTree* D) { DT = D; }
 158       uint32_t getNextUnusedValueNumber() { return nextValueNumber; }
 159       void verifyRemoved(const Value *) const;
 160   };
 161 }
 162
 163 namespace llvm {
 164 template <> struct DenseMapInfo<Expression> {
 165   static inline Expression getEmptyKey() {
 166     return Expression(Expression::EMPTY);
 167   }
 168
 169   static inline Expression getTombstoneKey() {
 170     return Expression(Expression::TOMBSTONE);
 171   }
 172
 173   static unsigned getHashValue(const Expression e) {
 174     unsigned hash = e.opcode;
 175
 176     hash = e.firstVN + hash * 37;
 177     hash = e.secondVN + hash * 37;
 178     hash = e.thirdVN + hash * 37;
 179
 180     hash = ((unsigned)((uintptr_t)e.type >> 4) ^
 181             (unsigned)((uintptr_t)e.type >> 9)) +
 182            hash * 37;
 183
 184     for (SmallVector<uint32_t, 4>::const_iterator I = e.varargs.begin(),
 185          E = e.varargs.end(); I != E; ++I)
 186       hash = *I + hash * 37;
 187
 188     hash = ((unsigned)((uintptr_t)e.function >> 4) ^
 189             (unsigned)((uintptr_t)e.function >> 9)) +
 190            hash * 37;
 191
 192     return hash;
 193   }
 194   static bool isEqual(const Expression &LHS, const Expression &RHS) {
 195     return LHS == RHS;
 196   }
 197   static bool isPod() { return true; }
 198 };
 199 }
 200
 201 //===----------------------------------------------------------------------===//
 202 //                     ValueTable Internal Functions
 203 //===----------------------------------------------------------------------===//
 204 Expression::ExpressionOpcode ValueTable::getOpcode(BinaryOperator* BO) {
 205   switch(BO->getOpcode()) {
 206   default: // THIS SHOULD NEVER HAPPEN
 207     llvm_unreachable("Binary operator with unknown opcode?");
 208   case Instruction::Add:  return Expression::ADD;
 209   case Instruction::FAdd: return Expression::FADD;
 210   case Instruction::Sub:  return Expression::SUB;
 211   case Instruction::FSub: return Expression::FSUB;
 212   case Instruction::Mul:  return Expression::MUL;
 213   case Instruction::FMul: return Expression::FMUL;
 214   case Instruction::UDiv: return Expression::UDIV;
 215   case Instruction::SDiv: return Expression::SDIV;
 216   case Instruction::FDiv: return Expression::FDIV;
 217   case Instruction::URem: return Expression::UREM;
 218   case Instruction::SRem: return Expression::SREM;
 219   case Instruction::FRem: return Expression::FREM;
 220   case Instruction::Shl:  return Expression::SHL;
 221   case Instruction::LShr: return Expression::LSHR;
 222   case Instruction::AShr: return Expression::ASHR;
 223   case Instruction::And:  return Expression::AND;
 224   case Instruction::Or:   return Expression::OR;
 225   case Instruction::Xor:  return Expression::XOR;
 226   }
 227 }
 228
 229 Expression::ExpressionOpcode ValueTable::getOpcode(CmpInst* C) {
 230   if (isa<ICmpInst>(C)) {
 231     switch (C->getPredicate()) {
 232     default:  // THIS SHOULD NEVER HAPPEN
 233       llvm_unreachable("Comparison with unknown predicate?");
 234     case ICmpInst::ICMP_EQ:  return Expression::ICMPEQ;
 235     case ICmpInst::ICMP_NE:  return Expression::ICMPNE;
 236     case ICmpInst::ICMP_UGT: return Expression::ICMPUGT;
 237     case ICmpInst::ICMP_UGE: return Expression::ICMPUGE;
 238     case ICmpInst::ICMP_ULT: return Expression::ICMPULT;
 239     case ICmpInst::ICMP_ULE: return Expression::ICMPULE;
 240     case ICmpInst::ICMP_SGT: return Expression::ICMPSGT;
 241     case ICmpInst::ICMP_SGE: return Expression::ICMPSGE;
 242     case ICmpInst::ICMP_SLT: return Expression::ICMPSLT;
 243     case ICmpInst::ICMP_SLE: return Expression::ICMPSLE;
 244     }
 245   } else {
 246     switch (C->getPredicate()) {
 247     default: // THIS SHOULD NEVER HAPPEN
 248       llvm_unreachable("Comparison with unknown predicate?");
 249     case FCmpInst::FCMP_OEQ: return Expression::FCMPOEQ;
 250     case FCmpInst::FCMP_OGT: return Expression::FCMPOGT;
 251     case FCmpInst::FCMP_OGE: return Expression::FCMPOGE;
 252     case FCmpInst::FCMP_OLT: return Expression::FCMPOLT;
 253     case FCmpInst::FCMP_OLE: return Expression::FCMPOLE;
 254     case FCmpInst::FCMP_ONE: return Expression::FCMPONE;
 255     case FCmpInst::FCMP_ORD: return Expression::FCMPORD;
 256     case FCmpInst::FCMP_UNO: return Expression::FCMPUNO;
 257     case FCmpInst::FCMP_UEQ: return Expression::FCMPUEQ;
 258     case FCmpInst::FCMP_UGT: return Expression::FCMPUGT;
 259     case FCmpInst::FCMP_UGE: return Expression::FCMPUGE;
 260     case FCmpInst::FCMP_ULT: return Expression::FCMPULT;
 261     case FCmpInst::FCMP_ULE: return Expression::FCMPULE;
 262     case FCmpInst::FCMP_UNE: return Expression::FCMPUNE;
 263     }
 264   }
 265 }
 266
 267 Expression::ExpressionOpcode ValueTable::getOpcode(CastInst* C) {
 268   switch(C->getOpcode()) {
 269   default: // THIS SHOULD NEVER HAPPEN
 270     llvm_unreachable("Cast operator with unknown opcode?");
 271   case Instruction::Trunc:    return Expression::TRUNC;
 272   case Instruction::ZExt:     return Expression::ZEXT;
 273   case Instruction::SExt:     return Expression::SEXT;
 274   case Instruction::FPToUI:   return Expression::FPTOUI;
 275   case Instruction::FPToSI:   return Expression::FPTOSI;
 276   case Instruction::UIToFP:   return Expression::UITOFP;
 277   case Instruction::SIToFP:   return Expression::SITOFP;
 278   case Instruction::FPTrunc:  return Expression::FPTRUNC;
 279   case Instruction::FPExt:    return Expression::FPEXT;
 280   case Instruction::PtrToInt: return Expression::PTRTOINT;
 281   case Instruction::IntToPtr: return Expression::INTTOPTR;
 282   case Instruction::BitCast:  return Expression::BITCAST;
 283   }
 284 }
 285
 286 Expression ValueTable::create_expression(CallInst* C) {
 287   Expression e;
 288
 289   e.type = C->getType();
 290   e.firstVN = 0;
 291   e.secondVN = 0;
 292   e.thirdVN = 0;
 293   e.function = C->getCalledFunction();
 294   e.opcode = Expression::CALL;
 295
 296   for (CallInst::op_iterator I = C->op_begin()+1, E = C->op_end();
 297        I != E; ++I)
 298     e.varargs.push_back(lookup_or_add(*I));
 299
 300   return e;
 301 }
 302
 303 Expression ValueTable::create_expression(BinaryOperator* BO) {
 304   Expression e;
 305
 306   e.firstVN = lookup_or_add(BO->getOperand(0));
 307   e.secondVN = lookup_or_add(BO->getOperand(1));
 308   e.thirdVN = 0;
 309   e.function = 0;
 310   e.type = BO->getType();
 311   e.opcode = getOpcode(BO);
 312
 313   return e;
 314 }
 315
 316 Expression ValueTable::create_expression(CmpInst* C) {
 317   Expression e;
 318
 319   e.firstVN = lookup_or_add(C->getOperand(0));
 320   e.secondVN = lookup_or_add(C->getOperand(1));
 321   e.thirdVN = 0;
 322   e.function = 0;
 323   e.type = C->getType();
 324   e.opcode = getOpcode(C);
 325
 326   return e;
 327 }
 328
 329 Expression ValueTable::create_expression(CastInst* C) {
 330   Expression e;
 331
 332   e.firstVN = lookup_or_add(C->getOperand(0));
 333   e.secondVN = 0;
 334   e.thirdVN = 0;
 335   e.function = 0;
 336   e.type = C->getType();
 337   e.opcode = getOpcode(C);
 338
 339   return e;
 340 }
 341
 342 Expression ValueTable::create_expression(ShuffleVectorInst* S) {
 343   Expression e;
 344
 345   e.firstVN = lookup_or_add(S->getOperand(0));
 346   e.secondVN = lookup_or_add(S->getOperand(1));
 347   e.thirdVN = lookup_or_add(S->getOperand(2));
 348   e.function = 0;
 349   e.type = S->getType();
 350   e.opcode = Expression::SHUFFLE;
 351
 352   return e;
 353 }
 354
 355 Expression ValueTable::create_expression(ExtractElementInst* E) {
 356   Expression e;
 357
 358   e.firstVN = lookup_or_add(E->getOperand(0));
 359   e.secondVN = lookup_or_add(E->getOperand(1));
 360   e.thirdVN = 0;
 361   e.function = 0;
 362   e.type = E->getType();
 363   e.opcode = Expression::EXTRACT;
 364
 365   return e;
 366 }
 367
 368 Expression ValueTable::create_expression(InsertElementInst* I) {
 369   Expression e;
 370
 371   e.firstVN = lookup_or_add(I->getOperand(0));
 372   e.secondVN = lookup_or_add(I->getOperand(1));
 373   e.thirdVN = lookup_or_add(I->getOperand(2));
 374   e.function = 0;
 375   e.type = I->getType();
 376   e.opcode = Expression::INSERT;
 377
 378   return e;
 379 }
 380
 381 Expression ValueTable::create_expression(SelectInst* I) {
 382   Expression e;
 383
 384   e.firstVN = lookup_or_add(I->getCondition());
 385   e.secondVN = lookup_or_add(I->getTrueValue());
 386   e.thirdVN = lookup_or_add(I->getFalseValue());
 387   e.function = 0;
 388   e.type = I->getType();
 389   e.opcode = Expression::SELECT;
 390
 391   return e;
 392 }
 393
 394 Expression ValueTable::create_expression(GetElementPtrInst* G) {
 395   Expression e;
 396
 397   e.firstVN = lookup_or_add(G->getPointerOperand());
 398   e.secondVN = 0;
 399   e.thirdVN = 0;
 400   e.function = 0;
 401   e.type = G->getType();
 402   e.opcode = Expression::GEP;
 403
 404   for (GetElementPtrInst::op_iterator I = G->idx_begin(), E = G->idx_end();
 405        I != E; ++I)
 406     e.varargs.push_back(lookup_or_add(*I));
 407
 408   return e;
 409 }
 410
 411 //===----------------------------------------------------------------------===//
 412 //                     ValueTable External Functions
 413 //===----------------------------------------------------------------------===//
 414
 415 /// add - Insert a value into the table with a specified value number.
 416 void ValueTable::add(Value* V, uint32_t num) {
 417   valueNumbering.insert(std::make_pair(V, num));
 418 }
 419
 420 /// lookup_or_add - Returns the value number for the specified value, assigning
 421 /// it a new number if it did not have one before.
 422 uint32_t ValueTable::lookup_or_add(Value* V) {
 423   DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
 424   if (VI != valueNumbering.end())
 425     return VI->second;
 426
 427   if (CallInst* C = dyn_cast<CallInst>(V)) {
 428     if (AA->doesNotAccessMemory(C)) {
 429       Expression e = create_expression(C);
 430
 431       DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 432       if (EI != expressionNumbering.end()) {
 433         valueNumbering.insert(std::make_pair(V, EI->second));
 434         return EI->second;
 435       } else {
 436         expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 437         valueNumbering.insert(std::make_pair(V, nextValueNumber));
 438
 439         return nextValueNumber++;
 440       }
 441     } else if (AA->onlyReadsMemory(C)) {
 442       Expression e = create_expression(C);
 443
 444       if (expressionNumbering.find(e) == expressionNumbering.end()) {
 445         expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 446         valueNumbering.insert(std::make_pair(V, nextValueNumber));
 447         return nextValueNumber++;
 448       }
 449
 450       MemDepResult local_dep = MD->getDependency(C);
 451
 452       if (!local_dep.isDef() && !local_dep.isNonLocal()) {
 453         valueNumbering.insert(std::make_pair(V, nextValueNumber));
 454         return nextValueNumber++;
 455       }
 456
 457       if (local_dep.isDef()) {
 458         CallInst* local_cdep = cast<CallInst>(local_dep.getInst());
 459
 460         if (local_cdep->getNumOperands() != C->getNumOperands()) {
 461           valueNumbering.insert(std::make_pair(V, nextValueNumber));
 462           return nextValueNumber++;
 463         }
 464
 465         for (unsigned i = 1; i < C->getNumOperands(); ++i) {
 466           uint32_t c_vn = lookup_or_add(C->getOperand(i));
 467           uint32_t cd_vn = lookup_or_add(local_cdep->getOperand(i));
 468           if (c_vn != cd_vn) {
 469             valueNumbering.insert(std::make_pair(V, nextValueNumber));
 470             return nextValueNumber++;
 471           }
 472         }
 473
 474         uint32_t v = lookup_or_add(local_cdep);
 475         valueNumbering.insert(std::make_pair(V, v));
 476         return v;
 477       }
 478
 479       // Non-local case.
 480       const MemoryDependenceAnalysis::NonLocalDepInfo &deps =
 481         MD->getNonLocalCallDependency(CallSite(C));
 482       // FIXME: call/call dependencies for readonly calls should return def, not
 483       // clobber!  Move the checking logic to MemDep!
 484       CallInst* cdep = 0;
 485
 486       // Check to see if we have a single dominating call instruction that is
 487       // identical to C.
 488       for (unsigned i = 0, e = deps.size(); i != e; ++i) {
 489         const MemoryDependenceAnalysis::NonLocalDepEntry *I = &deps[i];
 490         // Ignore non-local dependencies.
 491         if (I->second.isNonLocal())
 492           continue;
 493
 494         // We don't handle non-depedencies.  If we already have a call, reject
 495         // instruction dependencies.
 496         if (I->second.isClobber() || cdep != 0) {
 497           cdep = 0;
 498           break;
 499         }
 500
 501         CallInst *NonLocalDepCall = dyn_cast<CallInst>(I->second.getInst());
 502         // FIXME: All duplicated with non-local case.
 503         if (NonLocalDepCall && DT->properlyDominates(I->first, C->getParent())){
 504           cdep = NonLocalDepCall;
 505           continue;
 506         }
 507
 508         cdep = 0;
 509         break;
 510       }
 511
 512       if (!cdep) {
 513         valueNumbering.insert(std::make_pair(V, nextValueNumber));
 514         return nextValueNumber++;
 515       }
 516
 517       if (cdep->getNumOperands() != C->getNumOperands()) {
 518         valueNumbering.insert(std::make_pair(V, nextValueNumber));
 519         return nextValueNumber++;
 520       }
 521       for (unsigned i = 1; i < C->getNumOperands(); ++i) {
 522         uint32_t c_vn = lookup_or_add(C->getOperand(i));
 523         uint32_t cd_vn = lookup_or_add(cdep->getOperand(i));
 524         if (c_vn != cd_vn) {
 525           valueNumbering.insert(std::make_pair(V, nextValueNumber));
 526           return nextValueNumber++;
 527         }
 528       }
 529
 530       uint32_t v = lookup_or_add(cdep);
 531       valueNumbering.insert(std::make_pair(V, v));
 532       return v;
 533
 534     } else {
 535       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 536       return nextValueNumber++;
 537     }
 538   } else if (BinaryOperator* BO = dyn_cast<BinaryOperator>(V)) {
 539     Expression e = create_expression(BO);
 540
 541     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 542     if (EI != expressionNumbering.end()) {
 543       valueNumbering.insert(std::make_pair(V, EI->second));
 544       return EI->second;
 545     } else {
 546       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 547       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 548
 549       return nextValueNumber++;
 550     }
 551   } else if (CmpInst* C = dyn_cast<CmpInst>(V)) {
 552     Expression e = create_expression(C);
 553
 554     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 555     if (EI != expressionNumbering.end()) {
 556       valueNumbering.insert(std::make_pair(V, EI->second));
 557       return EI->second;
 558     } else {
 559       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 560       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 561
 562       return nextValueNumber++;
 563     }
 564   } else if (ShuffleVectorInst* U = dyn_cast<ShuffleVectorInst>(V)) {
 565     Expression e = create_expression(U);
 566
 567     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 568     if (EI != expressionNumbering.end()) {
 569       valueNumbering.insert(std::make_pair(V, EI->second));
 570       return EI->second;
 571     } else {
 572       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 573       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 574
 575       return nextValueNumber++;
 576     }
 577   } else if (ExtractElementInst* U = dyn_cast<ExtractElementInst>(V)) {
 578     Expression e = create_expression(U);
 579
 580     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 581     if (EI != expressionNumbering.end()) {
 582       valueNumbering.insert(std::make_pair(V, EI->second));
 583       return EI->second;
 584     } else {
 585       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 586       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 587
 588       return nextValueNumber++;
 589     }
 590   } else if (InsertElementInst* U = dyn_cast<InsertElementInst>(V)) {
 591     Expression e = create_expression(U);
 592
 593     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 594     if (EI != expressionNumbering.end()) {
 595       valueNumbering.insert(std::make_pair(V, EI->second));
 596       return EI->second;
 597     } else {
 598       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 599       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 600
 601       return nextValueNumber++;
 602     }
 603   } else if (SelectInst* U = dyn_cast<SelectInst>(V)) {
 604     Expression e = create_expression(U);
 605
 606     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 607     if (EI != expressionNumbering.end()) {
 608       valueNumbering.insert(std::make_pair(V, EI->second));
 609       return EI->second;
 610     } else {
 611       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 612       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 613
 614       return nextValueNumber++;
 615     }
 616   } else if (CastInst* U = dyn_cast<CastInst>(V)) {
 617     Expression e = create_expression(U);
 618
 619     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 620     if (EI != expressionNumbering.end()) {
 621       valueNumbering.insert(std::make_pair(V, EI->second));
 622       return EI->second;
 623     } else {
 624       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 625       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 626
 627       return nextValueNumber++;
 628     }
 629   } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(V)) {
 630     Expression e = create_expression(U);
 631
 632     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 633     if (EI != expressionNumbering.end()) {
 634       valueNumbering.insert(std::make_pair(V, EI->second));
 635       return EI->second;
 636     } else {
 637       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 638       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 639
 640       return nextValueNumber++;
 641     }
 642   } else {
 643     valueNumbering.insert(std::make_pair(V, nextValueNumber));
 644     return nextValueNumber++;
 645   }
 646 }
 647
 648 /// lookup - Returns the value number of the specified value. Fails if
 649 /// the value has not yet been numbered.
 650 uint32_t ValueTable::lookup(Value* V) const {
 651   DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
 652   assert(VI != valueNumbering.end() && "Value not numbered?");
 653   return VI->second;
 654 }
 655
 656 /// clear - Remove all entries from the ValueTable
 657 void ValueTable::clear() {
 658   valueNumbering.clear();
 659   expressionNumbering.clear();
 660   nextValueNumber = 1;
 661 }
 662
 663 /// erase - Remove a value from the value numbering
 664 void ValueTable::erase(Value* V) {
 665   valueNumbering.erase(V);
 666 }
 667
 668 /// verifyRemoved - Verify that the value is removed from all internal data
 669 /// structures.
 670 void ValueTable::verifyRemoved(const Value *V) const {
 671   for (DenseMap<Value*, uint32_t>::iterator
 672          I = valueNumbering.begin(), E = valueNumbering.end(); I != E; ++I) {
 673     assert(I->first != V && "Inst still occurs in value numbering map!");
 674   }
 675 }
 676
 677 //===----------------------------------------------------------------------===//
 678 //                                GVN Pass
 679 //===----------------------------------------------------------------------===//
 680
 681 namespace {
 682   struct ValueNumberScope {
 683     ValueNumberScope* parent;
 684     DenseMap<uint32_t, Value*> table;
 685
 686     ValueNumberScope(ValueNumberScope* p) : parent(p) { }
 687   };
 688 }
 689
 690 namespace {
 691
 692   class GVN : public FunctionPass {
 693     bool runOnFunction(Function &F);
 694   public:
 695     static char ID; // Pass identification, replacement for typeid
 696     GVN() : FunctionPass(&ID) { }
 697
 698   private:
 699     MemoryDependenceAnalysis *MD;
 700     DominatorTree *DT;
 701
 702     ValueTable VN;
 703     DenseMap<BasicBlock*, ValueNumberScope*> localAvail;
 704
 705     typedef DenseMap<Value*, SmallPtrSet<Instruction*, 4> > PhiMapType;
 706     PhiMapType phiMap;
 707
 708
 709     // This transformation requires dominator postdominator info
 710     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 711       AU.addRequired<DominatorTree>();
 712       AU.addRequired<MemoryDependenceAnalysis>();
 713       AU.addRequired<AliasAnalysis>();
 714
 715       AU.addPreserved<DominatorTree>();
 716       AU.addPreserved<AliasAnalysis>();
 717     }
 718
 719     // Helper fuctions
 720     // FIXME: eliminate or document these better
 721     bool processLoad(LoadInst* L,
 722                      SmallVectorImpl<Instruction*> &toErase);
 723     bool processInstruction(Instruction* I,
 724                             SmallVectorImpl<Instruction*> &toErase);
 725     bool processNonLocalLoad(LoadInst* L,
 726                              SmallVectorImpl<Instruction*> &toErase);
 727     bool processBlock(BasicBlock* BB);
 728     Value *GetValueForBlock(BasicBlock *BB, Instruction* orig,
 729                             DenseMap<BasicBlock*, Value*> &Phis,
 730                             bool top_level = false);
 731     void dump(DenseMap<uint32_t, Value*>& d);
 732     bool iterateOnFunction(Function &F);
 733     Value* CollapsePhi(PHINode* p);
 734     bool performPRE(Function& F);
 735     Value* lookupNumber(BasicBlock* BB, uint32_t num);
 736     Value* AttemptRedundancyElimination(Instruction* orig, unsigned valno);
 737     void cleanupGlobalSets();
 738     void verifyRemoved(const Instruction *I) const;
 739   };
 740
 741   char GVN::ID = 0;
 742 }
 743
 744 // createGVNPass - The public interface to this file...
 745 FunctionPass *llvm::createGVNPass() { return new GVN(); }
 746
 747 static RegisterPass<GVN> X("gvn",
 748                            "Global Value Numbering");
 749
 750 void GVN::dump(DenseMap<uint32_t, Value*>& d) {
 751   printf("{\n");
 752   for (DenseMap<uint32_t, Value*>::iterator I = d.begin(),
 753        E = d.end(); I != E; ++I) {
 754       printf("%d\n", I->first);
 755       I->second->dump();
 756   }
 757   printf("}\n");
 758 }
 759
 760 static bool isSafeReplacement(PHINode* p, Instruction* inst) {
 761   if (!isa<PHINode>(inst))
 762     return true;
 763
 764   for (Instruction::use_iterator UI = p->use_begin(), E = p->use_end();
 765        UI != E; ++UI)
 766     if (PHINode* use_phi = dyn_cast<PHINode>(UI))
 767       if (use_phi->getParent() == inst->getParent())
 768         return false;
 769
 770   return true;
 771 }
 772
 773 Value* GVN::CollapsePhi(PHINode* p) {
 774   Value* constVal = p->hasConstantValue(DT);
 775   if (!constVal) return 0;
 776
 777   Instruction* inst = dyn_cast<Instruction>(constVal);
 778   if (!inst)
 779     return constVal;
 780
 781   if (DT->dominates(inst, p))
 782     if (isSafeReplacement(p, inst))
 783       return inst;
 784   return 0;
 785 }
 786
 787 /// GetValueForBlock - Get the value to use within the specified basic block.
 788 /// available values are in Phis.
 789 Value *GVN::GetValueForBlock(BasicBlock *BB, Instruction* orig,
 790                              DenseMap<BasicBlock*, Value*> &Phis,
 791                              bool top_level) {
 792
 793   // If we have already computed this value, return the previously computed val.
 794   DenseMap<BasicBlock*, Value*>::iterator V = Phis.find(BB);
 795   if (V != Phis.end() && !top_level) return V->second;
 796
 797   // If the block is unreachable, just return undef, since this path
 798   // can't actually occur at runtime.
 799   if (!DT->isReachableFromEntry(BB))
 800     return Phis[BB] = UndefValue::get(orig->getType());
 801
 802   if (BasicBlock *Pred = BB->getSinglePredecessor()) {
 803     Value *ret = GetValueForBlock(Pred, orig, Phis);
 804     Phis[BB] = ret;
 805     return ret;
 806   }
 807
 808   // Get the number of predecessors of this block so we can reserve space later.
 809   // If there is already a PHI in it, use the #preds from it, otherwise count.
 810   // Getting it from the PHI is constant time.
 811   unsigned NumPreds;
 812   if (PHINode *ExistingPN = dyn_cast<PHINode>(BB->begin()))
 813     NumPreds = ExistingPN->getNumIncomingValues();
 814   else
 815     NumPreds = std::distance(pred_begin(BB), pred_end(BB));
 816
 817   // Otherwise, the idom is the loop, so we need to insert a PHI node.  Do so
 818   // now, then get values to fill in the incoming values for the PHI.
 819   PHINode *PN = PHINode::Create(orig->getType(), orig->getName()+".rle",
 820                                 BB->begin());
 821   PN->reserveOperandSpace(NumPreds);
 822
 823   Phis.insert(std::make_pair(BB, PN));
 824
 825   // Fill in the incoming values for the block.
 826   for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
 827     Value* val = GetValueForBlock(*PI, orig, Phis);
 828     PN->addIncoming(val, *PI);
 829   }
 830
 831   VN.getAliasAnalysis()->copyValue(orig, PN);
 832
 833   // Attempt to collapse PHI nodes that are trivially redundant
 834   Value* v = CollapsePhi(PN);
 835   if (!v) {
 836     // Cache our phi construction results
 837     if (LoadInst* L = dyn_cast<LoadInst>(orig))
 838       phiMap[L->getPointerOperand()].insert(PN);
 839     else
 840       phiMap[orig].insert(PN);
 841
 842     return PN;
 843   }
 844
 845   PN->replaceAllUsesWith(v);
 846   if (isa<PointerType>(v->getType()))
 847     MD->invalidateCachedPointerInfo(v);
 848
 849   for (DenseMap<BasicBlock*, Value*>::iterator I = Phis.begin(),
 850        E = Phis.end(); I != E; ++I)
 851     if (I->second == PN)
 852       I->second = v;
 853
 854   DEBUG(errs() << "GVN removed: " << *PN << '\n');
 855   MD->removeInstruction(PN);
 856   PN->eraseFromParent();
 857   DEBUG(verifyRemoved(PN));
 858
 859   Phis[BB] = v;
 860   return v;
 861 }
 862
 863 /// IsValueFullyAvailableInBlock - Return true if we can prove that the value
 864 /// we're analyzing is fully available in the specified block.  As we go, keep
 865 /// track of which blocks we know are fully alive in FullyAvailableBlocks.  This
 866 /// map is actually a tri-state map with the following values:
 867 ///   0) we know the block *is not* fully available.
 868 ///   1) we know the block *is* fully available.
 869 ///   2) we do not know whether the block is fully available or not, but we are
 870 ///      currently speculating that it will be.
 871 ///   3) we are speculating for this block and have used that to speculate for
 872 ///      other blocks.
 873 static bool IsValueFullyAvailableInBlock(BasicBlock *BB,
 874                             DenseMap<BasicBlock*, char> &FullyAvailableBlocks) {
 875   // Optimistically assume that the block is fully available and check to see
 876   // if we already know about this block in one lookup.
 877   std::pair<DenseMap<BasicBlock*, char>::iterator, char> IV =
 878     FullyAvailableBlocks.insert(std::make_pair(BB, 2));
 879
 880   // If the entry already existed for this block, return the precomputed value.
 881   if (!IV.second) {
 882     // If this is a speculative "available" value, mark it as being used for
 883     // speculation of other blocks.
 884     if (IV.first->second == 2)
 885       IV.first->second = 3;
 886     return IV.first->second != 0;
 887   }
 888
 889   // Otherwise, see if it is fully available in all predecessors.
 890   pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
 891
 892   // If this block has no predecessors, it isn't live-in here.
 893   if (PI == PE)
 894     goto SpeculationFailure;
 895
 896   for (; PI != PE; ++PI)
 897     // If the value isn't fully available in one of our predecessors, then it
 898     // isn't fully available in this block either.  Undo our previous
 899     // optimistic assumption and bail out.
 900     if (!IsValueFullyAvailableInBlock(*PI, FullyAvailableBlocks))
 901       goto SpeculationFailure;
 902
 903   return true;
 904
 905 // SpeculationFailure - If we get here, we found out that this is not, after
 906 // all, a fully-available block.  We have a problem if we speculated on this and
 907 // used the speculation to mark other blocks as available.
 908 SpeculationFailure:
 909   char &BBVal = FullyAvailableBlocks[BB];
 910
 911   // If we didn't speculate on this, just return with it set to false.
 912   if (BBVal == 2) {
 913     BBVal = 0;
 914     return false;
 915   }
 916
 917   // If we did speculate on this value, we could have blocks set to 1 that are
 918   // incorrect.  Walk the (transitive) successors of this block and mark them as
 919   // 0 if set to one.
 920   SmallVector<BasicBlock*, 32> BBWorklist;
 921   BBWorklist.push_back(BB);
 922
 923   while (!BBWorklist.empty()) {
 924     BasicBlock *Entry = BBWorklist.pop_back_val();
 925     // Note that this sets blocks to 0 (unavailable) if they happen to not
 926     // already be in FullyAvailableBlocks.  This is safe.
 927     char &EntryVal = FullyAvailableBlocks[Entry];
 928     if (EntryVal == 0) continue;  // Already unavailable.
 929
 930     // Mark as unavailable.
 931     EntryVal = 0;
 932
 933     for (succ_iterator I = succ_begin(Entry), E = succ_end(Entry); I != E; ++I)
 934       BBWorklist.push_back(*I);
 935   }
 936
 937   return false;
 938 }
 939
 940 /// processNonLocalLoad - Attempt to eliminate a load whose dependencies are
 941 /// non-local by performing PHI construction.
 942 bool GVN::processNonLocalLoad(LoadInst *LI,
 943                               SmallVectorImpl<Instruction*> &toErase) {
 944   // Find the non-local dependencies of the load.
 945   SmallVector<MemoryDependenceAnalysis::NonLocalDepEntry, 64> Deps;
 946   MD->getNonLocalPointerDependency(LI->getOperand(0), true, LI->getParent(),
 947                                    Deps);
 948   //DEBUG(errs() << "INVESTIGATING NONLOCAL LOAD: "
 949   //             << Deps.size() << *LI << '\n');
 950
 951   // If we had to process more than one hundred blocks to find the
 952   // dependencies, this load isn't worth worrying about.  Optimizing
 953   // it will be too expensive.
 954   if (Deps.size() > 100)
 955     return false;
 956
 957   // If we had a phi translation failure, we'll have a single entry which is a
 958   // clobber in the current block.  Reject this early.
 959   if (Deps.size() == 1 && Deps[0].second.isClobber()) {
 960     DEBUG(
 961       errs() << "GVN: non-local load ";
 962       WriteAsOperand(errs(), LI);
 963       errs() << " is clobbered by " << *Deps[0].second.getInst() << '\n';
 964     );
 965     return false;
 966   }
 967
 968   // Filter out useless results (non-locals, etc).  Keep track of the blocks
 969   // where we have a value available in repl, also keep track of whether we see
 970   // dependencies that produce an unknown value for the load (such as a call
 971   // that could potentially clobber the load).
 972   SmallVector<std::pair<BasicBlock*, Value*>, 16> ValuesPerBlock;
 973   SmallVector<BasicBlock*, 16> UnavailableBlocks;
 974
 975   for (unsigned i = 0, e = Deps.size(); i != e; ++i) {
 976     BasicBlock *DepBB = Deps[i].first;
 977     MemDepResult DepInfo = Deps[i].second;
 978
 979     if (DepInfo.isClobber()) {
 980       UnavailableBlocks.push_back(DepBB);
 981       continue;
 982     }
 983
 984     Instruction *DepInst = DepInfo.getInst();
 985
 986     // Loading the allocation -> undef.
 987     if (isa<AllocationInst>(DepInst) || isMalloc(DepInst)) {
 988       ValuesPerBlock.push_back(std::make_pair(DepBB,
 989                                UndefValue::get(LI->getType())));
 990       continue;
 991     }
 992
 993     if (StoreInst* S = dyn_cast<StoreInst>(DepInst)) {
 994       // Reject loads and stores that are to the same address but are of
 995       // different types.
 996       // NOTE: 403.gcc does have this case (e.g. in readonly_fields_p) because
 997       // of bitfield access, it would be interesting to optimize for it at some
 998       // point.
 999       if (S->getOperand(0)->getType() != LI->getType()) {
1000         UnavailableBlocks.push_back(DepBB);
1001         continue;
1002       }
1003
1004       ValuesPerBlock.push_back(std::make_pair(DepBB, S->getOperand(0)));
1005
1006     } else if (LoadInst* LD = dyn_cast<LoadInst>(DepInst)) {
1007       if (LD->getType() != LI->getType()) {
1008         UnavailableBlocks.push_back(DepBB);
1009         continue;
1010       }
1011       ValuesPerBlock.push_back(std::make_pair(DepBB, LD));
1012     } else {
1013       UnavailableBlocks.push_back(DepBB);
1014       continue;
1015     }
1016   }
1017
1018   // If we have no predecessors that produce a known value for this load, exit
1019   // early.
1020   if (ValuesPerBlock.empty()) return false;
1021
1022   // If all of the instructions we depend on produce a known value for this
1023   // load, then it is fully redundant and we can use PHI insertion to compute
1024   // its value.  Insert PHIs and remove the fully redundant value now.
1025   if (UnavailableBlocks.empty()) {
1026     // Use cached PHI construction information from previous runs
1027     SmallPtrSet<Instruction*, 4> &p = phiMap[LI->getPointerOperand()];
1028     // FIXME: What does phiMap do? Are we positive it isn't getting invalidated?
1029     for (SmallPtrSet<Instruction*, 4>::iterator I = p.begin(), E = p.end();
1030          I != E; ++I) {
1031       if ((*I)->getParent() == LI->getParent()) {
1032         DEBUG(errs() << "GVN REMOVING NONLOCAL LOAD #1: " << *LI << '\n');
1033         LI->replaceAllUsesWith(*I);
1034         if (isa<PointerType>((*I)->getType()))
1035           MD->invalidateCachedPointerInfo(*I);
1036         toErase.push_back(LI);
1037         NumGVNLoad++;
1038         return true;
1039       }
1040
1041       ValuesPerBlock.push_back(std::make_pair((*I)->getParent(), *I));
1042     }
1043
1044     DEBUG(errs() << "GVN REMOVING NONLOCAL LOAD: " << *LI << '\n');
1045
1046     DenseMap<BasicBlock*, Value*> BlockReplValues;
1047     BlockReplValues.insert(ValuesPerBlock.begin(), ValuesPerBlock.end());
1048     // Perform PHI construction.
1049     Value* v = GetValueForBlock(LI->getParent(), LI, BlockReplValues, true);
1050     LI->replaceAllUsesWith(v);
1051
1052     if (isa<PHINode>(v))
1053       v->takeName(LI);
1054     if (isa<PointerType>(v->getType()))
1055       MD->invalidateCachedPointerInfo(v);
1056     toErase.push_back(LI);
1057     NumGVNLoad++;
1058     return true;
1059   }
1060
1061   if (!EnablePRE || !EnableLoadPRE)
1062     return false;
1063
1064   // Okay, we have *some* definitions of the value.  This means that the value
1065   // is available in some of our (transitive) predecessors.  Lets think about
1066   // doing PRE of this load.  This will involve inserting a new load into the
1067   // predecessor when it's not available.  We could do this in general, but
1068   // prefer to not increase code size.  As such, we only do this when we know
1069   // that we only have to insert *one* load (which means we're basically moving
1070   // the load, not inserting a new one).
1071
1072   SmallPtrSet<BasicBlock *, 4> Blockers;
1073   for (unsigned i = 0, e = UnavailableBlocks.size(); i != e; ++i)
1074     Blockers.insert(UnavailableBlocks[i]);
1075
1076   // Lets find first basic block with more than one predecessor.  Walk backwards
1077   // through predecessors if needed.
1078   BasicBlock *LoadBB = LI->getParent();
1079   BasicBlock *TmpBB = LoadBB;
1080
1081   bool isSinglePred = false;
1082   bool allSingleSucc = true;
1083   while (TmpBB->getSinglePredecessor()) {
1084     isSinglePred = true;
1085     TmpBB = TmpBB->getSinglePredecessor();
1086     if (!TmpBB) // If haven't found any, bail now.
1087       return false;
1088     if (TmpBB == LoadBB) // Infinite (unreachable) loop.
1089       return false;
1090     if (Blockers.count(TmpBB))
1091       return false;
1092     if (TmpBB->getTerminator()->getNumSuccessors() != 1)
1093       allSingleSucc = false;
1094   }
1095
1096   assert(TmpBB);
1097   LoadBB = TmpBB;
1098
1099   // If we have a repl set with LI itself in it, this means we have a loop where
1100   // at least one of the values is LI.  Since this means that we won't be able
1101   // to eliminate LI even if we insert uses in the other predecessors, we will
1102   // end up increasing code size.  Reject this by scanning for LI.
1103   for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i)
1104     if (ValuesPerBlock[i].second == LI)
1105       return false;
1106
1107   if (isSinglePred) {
1108     bool isHot = false;
1109     for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i)
1110       if (Instruction *I = dyn_cast<Instruction>(ValuesPerBlock[i].second))
1111         // "Hot" Instruction is in some loop (because it dominates its dep.
1112         // instruction).
1113         if (DT->dominates(LI, I)) {
1114           isHot = true;
1115           break;
1116         }
1117
1118     // We are interested only in "hot" instructions. We don't want to do any
1119     // mis-optimizations here.
1120     if (!isHot)
1121       return false;
1122   }
1123
1124   // Okay, we have some hope :).  Check to see if the loaded value is fully
1125   // available in all but one predecessor.
1126   // FIXME: If we could restructure the CFG, we could make a common pred with
1127   // all the preds that don't have an available LI and insert a new load into
1128   // that one block.
1129   BasicBlock *UnavailablePred = 0;
1130
1131   DenseMap<BasicBlock*, char> FullyAvailableBlocks;
1132   for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i)
1133     FullyAvailableBlocks[ValuesPerBlock[i].first] = true;
1134   for (unsigned i = 0, e = UnavailableBlocks.size(); i != e; ++i)
1135     FullyAvailableBlocks[UnavailableBlocks[i]] = false;
1136
1137   for (pred_iterator PI = pred_begin(LoadBB), E = pred_end(LoadBB);
1138        PI != E; ++PI) {
1139     if (IsValueFullyAvailableInBlock(*PI, FullyAvailableBlocks))
1140       continue;
1141
1142     // If this load is not available in multiple predecessors, reject it.
1143     if (UnavailablePred && UnavailablePred != *PI)
1144       return false;
1145     UnavailablePred = *PI;
1146   }
1147
1148   assert(UnavailablePred != 0 &&
1149          "Fully available value should be eliminated above!");
1150
1151   // If the loaded pointer is PHI node defined in this block, do PHI translation
1152   // to get its value in the predecessor.
1153   Value *LoadPtr = LI->getOperand(0)->DoPHITranslation(LoadBB, UnavailablePred);
1154
1155   // Make sure the value is live in the predecessor.  If it was defined by a
1156   // non-PHI instruction in this block, we don't know how to recompute it above.
1157   if (Instruction *LPInst = dyn_cast<Instruction>(LoadPtr))
1158     if (!DT->dominates(LPInst->getParent(), UnavailablePred)) {
1159       DEBUG(errs() << "COULDN'T PRE LOAD BECAUSE PTR IS UNAVAILABLE IN PRED: "
1160                    << *LPInst << '\n' << *LI << "\n");
1161       return false;
1162     }
1163
1164   // We don't currently handle critical edges :(
1165   if (UnavailablePred->getTerminator()->getNumSuccessors() != 1) {
1166     DEBUG(errs() << "COULD NOT PRE LOAD BECAUSE OF CRITICAL EDGE '"
1167                  << UnavailablePred->getName() << "': " << *LI << '\n');
1168     return false;
1169   }
1170
1171   // Make sure it is valid to move this load here.  We have to watch out for:
1172   //  @1 = getelementptr (i8* p, ...
1173   //  test p and branch if == 0
1174   //  load @1
1175   // It is valid to have the getelementptr before the test, even if p can be 0,
1176   // as getelementptr only does address arithmetic.
1177   // If we are not pushing the value through any multiple-successor blocks
1178   // we do not have this case.  Otherwise, check that the load is safe to
1179   // put anywhere; this can be improved, but should be conservatively safe.
1180   if (!allSingleSucc &&
1181       !isSafeToLoadUnconditionally(LoadPtr, UnavailablePred->getTerminator()))
1182     return false;
1183
1184   // Okay, we can eliminate this load by inserting a reload in the predecessor
1185   // and using PHI construction to get the value in the other predecessors, do
1186   // it.
1187   DEBUG(errs() << "GVN REMOVING PRE LOAD: " << *LI << '\n');
1188
1189   Value *NewLoad = new LoadInst(LoadPtr, LI->getName()+".pre", false,
1190                                 LI->getAlignment(),
1191                                 UnavailablePred->getTerminator());
1192
1193   SmallPtrSet<Instruction*, 4> &p = phiMap[LI->getPointerOperand()];
1194   for (SmallPtrSet<Instruction*, 4>::iterator I = p.begin(), E = p.end();
1195        I != E; ++I)
1196     ValuesPerBlock.push_back(std::make_pair((*I)->getParent(), *I));
1197
1198   DenseMap<BasicBlock*, Value*> BlockReplValues;
1199   BlockReplValues.insert(ValuesPerBlock.begin(), ValuesPerBlock.end());
1200   BlockReplValues[UnavailablePred] = NewLoad;
1201
1202   // Perform PHI construction.
1203   Value* v = GetValueForBlock(LI->getParent(), LI, BlockReplValues, true);
1204   LI->replaceAllUsesWith(v);
1205   if (isa<PHINode>(v))
1206     v->takeName(LI);
1207   if (isa<PointerType>(v->getType()))
1208     MD->invalidateCachedPointerInfo(v);
1209   toErase.push_back(LI);
1210   NumPRELoad++;
1211   return true;
1212 }
1213
1214 /// CoerceAvailableValueToLoadType - If we saw a store of a value to memory, and
1215 /// then a load from a must-aliased pointer of a different type, try to coerce
1216 /// the stored value.  LoadedTy is the type of the load we want to replace and
1217 /// InsertPt is the place to insert new instructions.
1218 ///
1219 /// If we can't do it, return null.
1220 static Value *CoerceAvailableValueToLoadType(Value *StoredVal,
1221                                              const Type *LoadedTy,
1222                                              Instruction *InsertPt,
1223                                              const TargetData &TD) {
1224   const Type *StoredValTy = StoredVal->getType();
1225
1226   uint64_t StoreSize = TD.getTypeSizeInBits(StoredValTy);
1227   uint64_t LoadSize = TD.getTypeSizeInBits(LoadedTy);
1228
1229   // If the store and reload are the same size, we can always reuse it.
1230   if (StoreSize == LoadSize) {
1231     if (isa<PointerType>(StoredValTy) && isa<PointerType>(LoadedTy)) {
1232       // Pointer to Pointer -> use bitcast.
1233       return new BitCastInst(StoredVal, LoadedTy, "", InsertPt);
1234     }
1235
1236     // Convert source pointers to integers, which can be bitcast.
1237     if (isa<PointerType>(StoredValTy)) {
1238       StoredValTy = TD.getIntPtrType(StoredValTy->getContext());
1239       StoredVal = new PtrToIntInst(StoredVal, StoredValTy, "", InsertPt);
1240     }
1241
1242     const Type *TypeToCastTo = LoadedTy;
1243     if (isa<PointerType>(TypeToCastTo))
1244       TypeToCastTo = TD.getIntPtrType(StoredValTy->getContext());
1245
1246     if (StoredValTy != TypeToCastTo)
1247       StoredVal = new BitCastInst(StoredVal, TypeToCastTo, "", InsertPt);
1248
1249     // Cast to pointer if the load needs a pointer type.
1250     if (isa<PointerType>(LoadedTy))
1251       StoredVal = new IntToPtrInst(StoredVal, LoadedTy, "", InsertPt);
1252
1253     return StoredVal;
1254   }
1255
1256   // If the loaded value is smaller than the available value, then we can
1257   // extract out a piece from it.  If the available value is too small, then we
1258   // can't do anything.
1259   if (StoreSize < LoadSize)
1260     return 0;
1261
1262   // Convert source pointers to integers, which can be manipulated.
1263   if (isa<PointerType>(StoredValTy)) {
1264     StoredValTy = TD.getIntPtrType(StoredValTy->getContext());
1265     StoredVal = new PtrToIntInst(StoredVal, StoredValTy, "", InsertPt);
1266   }
1267
1268   // Convert vectors and fp to integer, which can be manipulated.
1269   if (!isa<IntegerType>(StoredValTy)) {
1270     StoredValTy = IntegerType::get(StoredValTy->getContext(), StoreSize);
1271     StoredVal = new BitCastInst(StoredVal, StoredValTy, "", InsertPt);
1272   }
1273
1274   // If this is a big-endian system, we need to shift the value down to the low
1275   // bits so that a truncate will work.
1276   if (TD.isBigEndian()) {
1277     Constant *Val = ConstantInt::get(StoredVal->getType(), StoreSize-LoadSize);
1278     StoredVal = BinaryOperator::CreateLShr(StoredVal, Val, "tmp", InsertPt);
1279   }
1280
1281   // Truncate the integer to the right size now.
1282   const Type *NewIntTy = IntegerType::get(StoredValTy->getContext(), LoadSize);
1283   StoredVal = new TruncInst(StoredVal, NewIntTy, "trunc", InsertPt);
1284
1285   if (LoadedTy == NewIntTy)
1286     return StoredVal;
1287
1288   // If the result is a pointer, inttoptr.
1289   if (isa<PointerType>(LoadedTy))
1290     return new IntToPtrInst(StoredVal, LoadedTy, "inttoptr", InsertPt);
1291
1292   // Otherwise, bitcast.
1293   return new BitCastInst(StoredVal, LoadedTy, "bitcast", InsertPt);
1294 }
1295
1296
1297 /// processLoad - Attempt to eliminate a load, first by eliminating it
1298 /// locally, and then attempting non-local elimination if that fails.
1299 bool GVN::processLoad(LoadInst *L, SmallVectorImpl<Instruction*> &toErase) {
1300   if (L->isVolatile())
1301     return false;
1302
1303   // ... to a pointer that has been loaded from before...
1304   MemDepResult dep = MD->getDependency(L);
1305
1306   // If the value isn't available, don't do anything!
1307   if (dep.isClobber()) {
1308     // FIXME: In the future, we should handle things like:
1309     //   store i32 123, i32* %P
1310     //   %A = bitcast i32* %P to i8*
1311     //   %B = gep i8* %A, i32 1
1312     //   %C = load i8* %B
1313     //
1314     // We could do that by recognizing if the clobber instructions are obviously
1315     // a common base + constant offset, and if the previous store (or memset)
1316     // completely covers this load.  This sort of thing can happen in bitfield
1317     // access code.
1318     DEBUG(
1319       // fast print dep, using operator<< on instruction would be too slow
1320       errs() << "GVN: load ";
1321       WriteAsOperand(errs(), L);
1322       Instruction *I = dep.getInst();
1323       errs() << " is clobbered by " << *I << '\n';
1324     );
1325     return false;
1326   }
1327
1328   // If it is defined in another block, try harder.
1329   if (dep.isNonLocal())
1330     return processNonLocalLoad(L, toErase);
1331
1332   Instruction *DepInst = dep.getInst();
1333   if (StoreInst *DepSI = dyn_cast<StoreInst>(DepInst)) {
1334     Value *StoredVal = DepSI->getOperand(0);
1335
1336     // The store and load are to a must-aliased pointer, but they may not
1337     // actually have the same type.  See if we know how to reuse the stored
1338     // value (depending on its type).
1339     const TargetData *TD = 0;
1340     if (StoredVal->getType() != L->getType() &&
1341         (TD = getAnalysisIfAvailable<TargetData>())) {
1342       StoredVal = CoerceAvailableValueToLoadType(StoredVal, L->getType(), L, *TD);
1343       if (StoredVal == 0)
1344         return false;
1345
1346       DEBUG(errs() << "GVN COERCED STORE:\n" << *DepSI << '\n' << *StoredVal
1347                    << '\n' << *L << "\n\n\n");
1348     }
1349
1350     // Remove it!
1351     L->replaceAllUsesWith(StoredVal);
1352     if (isa<PointerType>(StoredVal->getType()))
1353       MD->invalidateCachedPointerInfo(StoredVal);
1354     toErase.push_back(L);
1355     NumGVNLoad++;
1356     return true;
1357   }
1358
1359   if (LoadInst *DepLI = dyn_cast<LoadInst>(DepInst)) {
1360     Value *AvailableVal = DepLI;
1361
1362     // The loads are of a must-aliased pointer, but they may not actually have
1363     // the same type.  See if we know how to reuse the previously loaded value
1364     // (depending on its type).
1365     const TargetData *TD = 0;
1366     if (DepLI->getType() != L->getType() &&
1367         (TD = getAnalysisIfAvailable<TargetData>())) {
1368       AvailableVal = CoerceAvailableValueToLoadType(DepLI, L->getType(), L, *TD);
1369       if (AvailableVal == 0)
1370         return false;
1371
1372       DEBUG(errs() << "GVN COERCED LOAD:\n" << *DepLI << "\n" << *AvailableVal
1373                    << "\n" << *L << "\n\n\n");
1374     }
1375
1376     // Remove it!
1377     L->replaceAllUsesWith(AvailableVal);
1378     if (isa<PointerType>(DepLI->getType()))
1379       MD->invalidateCachedPointerInfo(DepLI);
1380     toErase.push_back(L);
1381     NumGVNLoad++;
1382     return true;
1383   }
1384
1385   // FIXME: We should handle memset/memcpy/memmove as dependent instructions to
1386   // forward the value if available.
1387   //if (isa<MemIntrinsic>(DepInst))
1388   //  errs() << "LOAD DEPENDS ON MEM: " << *L << "\n" << *DepInst << "\n\n";
1389
1390
1391   // If this load really doesn't depend on anything, then we must be loading an
1392   // undef value.  This can happen when loading for a fresh allocation with no
1393   // intervening stores, for example.
1394   if (isa<AllocationInst>(DepInst) || isMalloc(DepInst)) {
1395     L->replaceAllUsesWith(UndefValue::get(L->getType()));
1396     toErase.push_back(L);
1397     NumGVNLoad++;
1398     return true;
1399   }
1400
1401   return false;
1402 }
1403
1404 Value* GVN::lookupNumber(BasicBlock* BB, uint32_t num) {
1405   DenseMap<BasicBlock*, ValueNumberScope*>::iterator I = localAvail.find(BB);
1406   if (I == localAvail.end())
1407     return 0;
1408
1409   ValueNumberScope* locals = I->second;
1410
1411   while (locals) {
1412     DenseMap<uint32_t, Value*>::iterator I = locals->table.find(num);
1413     if (I != locals->table.end())
1414       return I->second;
1415     else
1416       locals = locals->parent;
1417   }
1418
1419   return 0;
1420 }
1421
1422 /// AttemptRedundancyElimination - If the "fast path" of redundancy elimination
1423 /// by inheritance from the dominator fails, see if we can perform phi
1424 /// construction to eliminate the redundancy.
1425 Value* GVN::AttemptRedundancyElimination(Instruction* orig, unsigned valno) {
1426   BasicBlock* BaseBlock = orig->getParent();
1427
1428   SmallPtrSet<BasicBlock*, 4> Visited;
1429   SmallVector<BasicBlock*, 8> Stack;
1430   Stack.push_back(BaseBlock);
1431
1432   DenseMap<BasicBlock*, Value*> Results;
1433
1434   // Walk backwards through our predecessors, looking for instances of the
1435   // value number we're looking for.  Instances are recorded in the Results
1436   // map, which is then used to perform phi construction.
1437   while (!Stack.empty()) {
1438     BasicBlock* Current = Stack.back();
1439     Stack.pop_back();
1440
1441     // If we've walked all the way to a proper dominator, then give up. Cases
1442     // where the instance is in the dominator will have been caught by the fast
1443     // path, and any cases that require phi construction further than this are
1444     // probably not worth it anyways.  Note that this is a SIGNIFICANT compile
1445     // time improvement.
1446     if (DT->properlyDominates(Current, orig->getParent())) return 0;
1447
1448     DenseMap<BasicBlock*, ValueNumberScope*>::iterator LA =
1449                                                        localAvail.find(Current);
1450     if (LA == localAvail.end()) return 0;
1451     DenseMap<uint32_t, Value*>::iterator V = LA->second->table.find(valno);
1452
1453     if (V != LA->second->table.end()) {
1454       // Found an instance, record it.
1455       Results.insert(std::make_pair(Current, V->second));
1456       continue;
1457     }
1458
1459     // If we reach the beginning of the function, then give up.
1460     if (pred_begin(Current) == pred_end(Current))
1461       return 0;
1462
1463     for (pred_iterator PI = pred_begin(Current), PE = pred_end(Current);
1464          PI != PE; ++PI)
1465       if (Visited.insert(*PI))
1466         Stack.push_back(*PI);
1467   }
1468
1469   // If we didn't find instances, give up.  Otherwise, perform phi construction.
1470   if (Results.size() == 0)
1471     return 0;
1472   else
1473     return GetValueForBlock(BaseBlock, orig, Results, true);
1474 }
1475
1476 /// processInstruction - When calculating availability, handle an instruction
1477 /// by inserting it into the appropriate sets
1478 bool GVN::processInstruction(Instruction *I,
1479                              SmallVectorImpl<Instruction*> &toErase) {
1480   if (LoadInst* L = dyn_cast<LoadInst>(I)) {
1481     bool changed = processLoad(L, toErase);
1482
1483     if (!changed) {
1484       unsigned num = VN.lookup_or_add(L);
1485       localAvail[I->getParent()]->table.insert(std::make_pair(num, L));
1486     }
1487
1488     return changed;
1489   }
1490
1491   uint32_t nextNum = VN.getNextUnusedValueNumber();
1492   unsigned num = VN.lookup_or_add(I);
1493
1494   if (BranchInst* BI = dyn_cast<BranchInst>(I)) {
1495     localAvail[I->getParent()]->table.insert(std::make_pair(num, I));
1496
1497     if (!BI->isConditional() || isa<Constant>(BI->getCondition()))
1498       return false;
1499
1500     Value* branchCond = BI->getCondition();
1501     uint32_t condVN = VN.lookup_or_add(branchCond);
1502
1503     BasicBlock* trueSucc = BI->getSuccessor(0);
1504     BasicBlock* falseSucc = BI->getSuccessor(1);
1505
1506     if (trueSucc->getSinglePredecessor())
1507       localAvail[trueSucc]->table[condVN] =
1508         ConstantInt::getTrue(trueSucc->getContext());
1509     if (falseSucc->getSinglePredecessor())
1510       localAvail[falseSucc]->table[condVN] =
1511         ConstantInt::getFalse(trueSucc->getContext());
1512
1513     return false;
1514
1515   // Allocations are always uniquely numbered, so we can save time and memory
1516   // by fast failing them.
1517   } else if (isa<AllocationInst>(I) || isMalloc(I) || isa<TerminatorInst>(I)) {
1518     localAvail[I->getParent()]->table.insert(std::make_pair(num, I));
1519     return false;
1520   }
1521
1522   // Collapse PHI nodes
1523   if (PHINode* p = dyn_cast<PHINode>(I)) {
1524     Value* constVal = CollapsePhi(p);
1525
1526     if (constVal) {
1527       for (PhiMapType::iterator PI = phiMap.begin(), PE = phiMap.end();
1528            PI != PE; ++PI)
1529         PI->second.erase(p);
1530
1531       p->replaceAllUsesWith(constVal);
1532       if (isa<PointerType>(constVal->getType()))
1533         MD->invalidateCachedPointerInfo(constVal);
1534       VN.erase(p);
1535
1536       toErase.push_back(p);
1537     } else {
1538       localAvail[I->getParent()]->table.insert(std::make_pair(num, I));
1539     }
1540
1541   // If the number we were assigned was a brand new VN, then we don't
1542   // need to do a lookup to see if the number already exists
1543   // somewhere in the domtree: it can't!
1544   } else if (num == nextNum) {
1545     localAvail[I->getParent()]->table.insert(std::make_pair(num, I));
1546
1547   // Perform fast-path value-number based elimination of values inherited from
1548   // dominators.
1549   } else if (Value* repl = lookupNumber(I->getParent(), num)) {
1550     // Remove it!
1551     VN.erase(I);
1552     I->replaceAllUsesWith(repl);
1553     if (isa<PointerType>(repl->getType()))
1554       MD->invalidateCachedPointerInfo(repl);
1555     toErase.push_back(I);
1556     return true;
1557
1558 #if 0
1559   // Perform slow-pathvalue-number based elimination with phi construction.
1560   } else if (Value* repl = AttemptRedundancyElimination(I, num)) {
1561     // Remove it!
1562     VN.erase(I);
1563     I->replaceAllUsesWith(repl);
1564     if (isa<PointerType>(repl->getType()))
1565       MD->invalidateCachedPointerInfo(repl);
1566     toErase.push_back(I);
1567     return true;
1568 #endif
1569   } else {
1570     localAvail[I->getParent()]->table.insert(std::make_pair(num, I));
1571   }
1572
1573   return false;
1574 }
1575
1576 /// runOnFunction - This is the main transformation entry point for a function.
1577 bool GVN::runOnFunction(Function& F) {
1578   MD = &getAnalysis<MemoryDependenceAnalysis>();
1579   DT = &getAnalysis<DominatorTree>();
1580   VN.setAliasAnalysis(&getAnalysis<AliasAnalysis>());
1581   VN.setMemDep(MD);
1582   VN.setDomTree(DT);
1583
1584   bool changed = false;
1585   bool shouldContinue = true;
1586
1587   // Merge unconditional branches, allowing PRE to catch more
1588   // optimization opportunities.
1589   for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ) {
1590     BasicBlock* BB = FI;
1591     ++FI;
1592     bool removedBlock = MergeBlockIntoPredecessor(BB, this);
1593     if (removedBlock) NumGVNBlocks++;
1594
1595     changed |= removedBlock;
1596   }
1597
1598   unsigned Iteration = 0;
1599
1600   while (shouldContinue) {
1601     DEBUG(errs() << "GVN iteration: " << Iteration << "\n");
1602     shouldContinue = iterateOnFunction(F);
1603     changed |= shouldContinue;
1604     ++Iteration;
1605   }
1606
1607   if (EnablePRE) {
1608     bool PREChanged = true;
1609     while (PREChanged) {
1610       PREChanged = performPRE(F);
1611       changed |= PREChanged;
1612     }
1613   }
1614   // FIXME: Should perform GVN again after PRE does something.  PRE can move
1615   // computations into blocks where they become fully redundant.  Note that
1616   // we can't do this until PRE's critical edge splitting updates memdep.
1617   // Actually, when this happens, we should just fully integrate PRE into GVN.
1618
1619   cleanupGlobalSets();
1620
1621   return changed;
1622 }
1623
1624
1625 bool GVN::processBlock(BasicBlock* BB) {
1626   // FIXME: Kill off toErase by doing erasing eagerly in a helper function (and
1627   // incrementing BI before processing an instruction).
1628   SmallVector<Instruction*, 8> toErase;
1629   bool changed_function = false;
1630
1631   for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();
1632        BI != BE;) {
1633     changed_function |= processInstruction(BI, toErase);
1634     if (toErase.empty()) {
1635       ++BI;
1636       continue;
1637     }
1638
1639     // If we need some instructions deleted, do it now.
1640     NumGVNInstr += toErase.size();
1641
1642     // Avoid iterator invalidation.
1643     bool AtStart = BI == BB->begin();
1644     if (!AtStart)
1645       --BI;
1646
1647     for (SmallVector<Instruction*, 4>::iterator I = toErase.begin(),
1648          E = toErase.end(); I != E; ++I) {
1649       DEBUG(errs() << "GVN removed: " << **I << '\n');
1650       MD->removeInstruction(*I);
1651       (*I)->eraseFromParent();
1652       DEBUG(verifyRemoved(*I));
1653     }
1654     toErase.clear();
1655
1656     if (AtStart)
1657       BI = BB->begin();
1658     else
1659       ++BI;
1660   }
1661
1662   return changed_function;
1663 }
1664
1665 /// performPRE - Perform a purely local form of PRE that looks for diamond
1666 /// control flow patterns and attempts to perform simple PRE at the join point.
1667 bool GVN::performPRE(Function& F) {
1668   bool Changed = false;
1669   SmallVector<std::pair<TerminatorInst*, unsigned>, 4> toSplit;
1670   DenseMap<BasicBlock*, Value*> predMap;
1671   for (df_iterator<BasicBlock*> DI = df_begin(&F.getEntryBlock()),
1672        DE = df_end(&F.getEntryBlock()); DI != DE; ++DI) {
1673     BasicBlock* CurrentBlock = *DI;
1674
1675     // Nothing to PRE in the entry block.
1676     if (CurrentBlock == &F.getEntryBlock()) continue;
1677
1678     for (BasicBlock::iterator BI = CurrentBlock->begin(),
1679          BE = CurrentBlock->end(); BI != BE; ) {
1680       Instruction *CurInst = BI++;
1681
1682       if (isa<AllocationInst>(CurInst) || isMalloc(CurInst) ||
1683           isa<TerminatorInst>(CurInst) || isa<PHINode>(CurInst) ||
1684           (CurInst->getType() == Type::getVoidTy(F.getContext())) ||
1685           CurInst->mayReadFromMemory() || CurInst->mayHaveSideEffects() ||
1686           isa<DbgInfoIntrinsic>(CurInst))
1687         continue;
1688
1689       uint32_t valno = VN.lookup(CurInst);
1690
1691       // Look for the predecessors for PRE opportunities.  We're
1692       // only trying to solve the basic diamond case, where
1693       // a value is computed in the successor and one predecessor,
1694       // but not the other.  We also explicitly disallow cases
1695       // where the successor is its own predecessor, because they're
1696       // more complicated to get right.
1697       unsigned numWith = 0;
1698       unsigned numWithout = 0;
1699       BasicBlock* PREPred = 0;
1700       predMap.clear();
1701
1702       for (pred_iterator PI = pred_begin(CurrentBlock),
1703            PE = pred_end(CurrentBlock); PI != PE; ++PI) {
1704         // We're not interested in PRE where the block is its
1705         // own predecessor, on in blocks with predecessors
1706         // that are not reachable.
1707         if (*PI == CurrentBlock) {
1708           numWithout = 2;
1709           break;
1710         } else if (!localAvail.count(*PI))  {
1711           numWithout = 2;
1712           break;
1713         }
1714
1715         DenseMap<uint32_t, Value*>::iterator predV =
1716                                             localAvail[*PI]->table.find(valno);
1717         if (predV == localAvail[*PI]->table.end()) {
1718           PREPred = *PI;
1719           numWithout++;
1720         } else if (predV->second == CurInst) {
1721           numWithout = 2;
1722         } else {
1723           predMap[*PI] = predV->second;
1724           numWith++;
1725         }
1726       }
1727
1728       // Don't do PRE when it might increase code size, i.e. when
1729       // we would need to insert instructions in more than one pred.
1730       if (numWithout != 1 || numWith == 0)
1731         continue;
1732
1733       // We can't do PRE safely on a critical edge, so instead we schedule
1734       // the edge to be split and perform the PRE the next time we iterate
1735       // on the function.
1736       unsigned succNum = 0;
1737       for (unsigned i = 0, e = PREPred->getTerminator()->getNumSuccessors();
1738            i != e; ++i)
1739         if (PREPred->getTerminator()->getSuccessor(i) == CurrentBlock) {
1740           succNum = i;
1741           break;
1742         }
1743
1744       if (isCriticalEdge(PREPred->getTerminator(), succNum)) {
1745         toSplit.push_back(std::make_pair(PREPred->getTerminator(), succNum));
1746         continue;
1747       }
1748
1749       // Instantiate the expression the in predecessor that lacked it.
1750       // Because we are going top-down through the block, all value numbers
1751       // will be available in the predecessor by the time we need them.  Any
1752       // that weren't original present will have been instantiated earlier
1753       // in this loop.
1754       Instruction* PREInstr = CurInst->clone(CurInst->getContext());
1755       bool success = true;
1756       for (unsigned i = 0, e = CurInst->getNumOperands(); i != e; ++i) {
1757         Value *Op = PREInstr->getOperand(i);
1758         if (isa<Argument>(Op) || isa<Constant>(Op) || isa<GlobalValue>(Op))
1759           continue;
1760
1761         if (Value *V = lookupNumber(PREPred, VN.lookup(Op))) {
1762           PREInstr->setOperand(i, V);
1763         } else {
1764           success = false;
1765           break;
1766         }
1767       }
1768
1769       // Fail out if we encounter an operand that is not available in
1770       // the PRE predecessor.  This is typically because of loads which
1771       // are not value numbered precisely.
1772       if (!success) {
1773         delete PREInstr;
1774         DEBUG(verifyRemoved(PREInstr));
1775         continue;
1776       }
1777
1778       PREInstr->insertBefore(PREPred->getTerminator());
1779       PREInstr->setName(CurInst->getName() + ".pre");
1780       predMap[PREPred] = PREInstr;
1781       VN.add(PREInstr, valno);
1782       NumGVNPRE++;
1783
1784       // Update the availability map to include the new instruction.
1785       localAvail[PREPred]->table.insert(std::make_pair(valno, PREInstr));
1786
1787       // Create a PHI to make the value available in this block.
1788       PHINode* Phi = PHINode::Create(CurInst->getType(),
1789                                      CurInst->getName() + ".pre-phi",
1790                                      CurrentBlock->begin());
1791       for (pred_iterator PI = pred_begin(CurrentBlock),
1792            PE = pred_end(CurrentBlock); PI != PE; ++PI)
1793         Phi->addIncoming(predMap[*PI], *PI);
1794
1795       VN.add(Phi, valno);
1796       localAvail[CurrentBlock]->table[valno] = Phi;
1797
1798       CurInst->replaceAllUsesWith(Phi);
1799       if (isa<PointerType>(Phi->getType()))
1800         MD->invalidateCachedPointerInfo(Phi);
1801       VN.erase(CurInst);
1802
1803       DEBUG(errs() << "GVN PRE removed: " << *CurInst << '\n');
1804       MD->removeInstruction(CurInst);
1805       CurInst->eraseFromParent();
1806       DEBUG(verifyRemoved(CurInst));
1807       Changed = true;
1808     }
1809   }
1810
1811   for (SmallVector<std::pair<TerminatorInst*, unsigned>, 4>::iterator
1812        I = toSplit.begin(), E = toSplit.end(); I != E; ++I)
1813     SplitCriticalEdge(I->first, I->second, this);
1814
1815   return Changed || toSplit.size();
1816 }
1817
1818 /// iterateOnFunction - Executes one iteration of GVN
1819 bool GVN::iterateOnFunction(Function &F) {
1820   cleanupGlobalSets();
1821
1822   for (df_iterator<DomTreeNode*> DI = df_begin(DT->getRootNode()),
1823        DE = df_end(DT->getRootNode()); DI != DE; ++DI) {
1824     if (DI->getIDom())
1825       localAvail[DI->getBlock()] =
1826                    new ValueNumberScope(localAvail[DI->getIDom()->getBlock()]);
1827     else
1828       localAvail[DI->getBlock()] = new ValueNumberScope(0);
1829   }
1830
1831   // Top-down walk of the dominator tree
1832   bool changed = false;
1833 #if 0
1834   // Needed for value numbering with phi construction to work.
1835   ReversePostOrderTraversal<Function*> RPOT(&F);
1836   for (ReversePostOrderTraversal<Function*>::rpo_iterator RI = RPOT.begin(),
1837        RE = RPOT.end(); RI != RE; ++RI)
1838     changed |= processBlock(*RI);
1839 #else
1840   for (df_iterator<DomTreeNode*> DI = df_begin(DT->getRootNode()),
1841        DE = df_end(DT->getRootNode()); DI != DE; ++DI)
1842     changed |= processBlock(DI->getBlock());
1843 #endif
1844
1845   return changed;
1846 }
1847
1848 void GVN::cleanupGlobalSets() {
1849   VN.clear();
1850   phiMap.clear();
1851
1852   for (DenseMap<BasicBlock*, ValueNumberScope*>::iterator
1853        I = localAvail.begin(), E = localAvail.end(); I != E; ++I)
1854     delete I->second;
1855   localAvail.clear();
1856 }
1857
1858 /// verifyRemoved - Verify that the specified instruction does not occur in our
1859 /// internal data structures.
1860 void GVN::verifyRemoved(const Instruction *Inst) const {
1861   VN.verifyRemoved(Inst);
1862
1863   // Walk through the PHI map to make sure the instruction isn't hiding in there
1864   // somewhere.
1865   for (PhiMapType::iterator
1866          I = phiMap.begin(), E = phiMap.end(); I != E; ++I) {
1867     assert(I->first != Inst && "Inst is still a key in PHI map!");
1868
1869     for (SmallPtrSet<Instruction*, 4>::iterator
1870            II = I->second.begin(), IE = I->second.end(); II != IE; ++II) {
1871       assert(*II != Inst && "Inst is still a value in PHI map!");
1872     }
1873   }
1874
1875   // Walk through the value number scope to make sure the instruction isn't
1876   // ferreted away in it.
1877   for (DenseMap<BasicBlock*, ValueNumberScope*>::iterator
1878          I = localAvail.begin(), E = localAvail.end(); I != E; ++I) {
1879     const ValueNumberScope *VNS = I->second;
1880
1881     while (VNS) {
1882       for (DenseMap<uint32_t, Value*>::iterator
1883              II = VNS->table.begin(), IE = VNS->table.end(); II != IE; ++II) {
1884         assert(II->second != Inst && "Inst still in value numbering scope!");
1885       }
1886
1887       VNS = VNS->parent;
1888     }
1889   }
1890 }