lib/Transforms/Scalar/GVNPRE.cpp

   1 //===- GVNPRE.cpp - Eliminate redundant values and expressions ------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the Owen Anderson and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This pass performs a hybrid of global value numbering and partial redundancy
  11 // elimination, known as GVN-PRE.  It performs partial redundancy elimination on
  12 // values, rather than lexical expressions, allowing a more comprehensive view
  13 // the optimization.  It replaces redundant values with uses of earlier
  14 // occurences of the same value.  While this is beneficial in that it eliminates
  15 // unneeded computation, it also increases register pressure by creating large
  16 // live ranges, and should be used with caution on platforms that are very
  17 // sensitive to register pressure.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #define DEBUG_TYPE "gvnpre"
  22 #include "llvm/Value.h"
  23 #include "llvm/Transforms/Scalar.h"
  24 #include "llvm/Instructions.h"
  25 #include "llvm/Function.h"
  26 #include "llvm/DerivedTypes.h"
  27 #include "llvm/Analysis/Dominators.h"
  28 #include "llvm/ADT/BitVector.h"
  29 #include "llvm/ADT/DenseMap.h"
  30 #include "llvm/ADT/DepthFirstIterator.h"
  31 #include "llvm/ADT/PostOrderIterator.h"
  32 #include "llvm/ADT/SmallPtrSet.h"
  33 #include "llvm/ADT/Statistic.h"
  34 #include "llvm/Transforms/Utils/UnifyFunctionExitNodes.h"
  35 #include "llvm/Support/CFG.h"
  36 #include "llvm/Support/Compiler.h"
  37 #include "llvm/Support/Debug.h"
  38 #include <algorithm>
  39 #include <deque>
  40 #include <map>
  41 #include <vector>
  42 #include <set>
  43 using namespace llvm;
  44
  45 //===----------------------------------------------------------------------===//
  46 //                         ValueTable Class
  47 //===----------------------------------------------------------------------===//
  48
  49 /// This class holds the mapping between values and value numbers.  It is used
  50 /// as an efficient mechanism to determine the expression-wise equivalence of
  51 /// two values.
  52
  53 namespace {
  54   class VISIBILITY_HIDDEN ValueTable {
  55     public:
  56       struct Expression {
  57         enum ExpressionOpcode { ADD, SUB, MUL, UDIV, SDIV, FDIV, UREM, SREM,
  58                               FREM, SHL, LSHR, ASHR, AND, OR, XOR, ICMPEQ,
  59                               ICMPNE, ICMPUGT, ICMPUGE, ICMPULT, ICMPULE,
  60                               ICMPSGT, ICMPSGE, ICMPSLT, ICMPSLE, FCMPOEQ,
  61                               FCMPOGT, FCMPOGE, FCMPOLT, FCMPOLE, FCMPONE,
  62                               FCMPORD, FCMPUNO, FCMPUEQ, FCMPUGT, FCMPUGE,
  63                               FCMPULT, FCMPULE, FCMPUNE, EXTRACT, INSERT,
  64                               SHUFFLE, SELECT, TRUNC, ZEXT, SEXT, FPTOUI,
  65                               FPTOSI, UITOFP, SITOFP, FPTRUNC, FPEXT,
  66                               PTRTOINT, INTTOPTR, BITCAST, GEP};
  67
  68         ExpressionOpcode opcode;
  69         const Type* type;
  70         uint32_t firstVN;
  71         uint32_t secondVN;
  72         uint32_t thirdVN;
  73         std::vector<uint32_t> varargs;
  74
  75         bool operator< (const Expression& other) const {
  76           if (opcode < other.opcode)
  77             return true;
  78           else if (opcode > other.opcode)
  79             return false;
  80           else if (type < other.type)
  81             return true;
  82           else if (type > other.type)
  83             return false;
  84           else if (firstVN < other.firstVN)
  85             return true;
  86           else if (firstVN > other.firstVN)
  87             return false;
  88           else if (secondVN < other.secondVN)
  89             return true;
  90           else if (secondVN > other.secondVN)
  91             return false;
  92           else if (thirdVN < other.thirdVN)
  93             return true;
  94           else if (thirdVN > other.thirdVN)
  95             return false;
  96           else {
  97             if (varargs.size() < other.varargs.size())
  98               return true;
  99             else if (varargs.size() > other.varargs.size())
 100               return false;
 101
 102             for (size_t i = 0; i < varargs.size(); ++i)
 103               if (varargs[i] < other.varargs[i])
 104                 return true;
 105               else if (varargs[i] > other.varargs[i])
 106                 return false;
 107
 108             return false;
 109           }
 110         }
 111       };
 112
 113     private:
 114       DenseMap<Value*, uint32_t> valueNumbering;
 115       std::map<Expression, uint32_t> expressionNumbering;
 116
 117       uint32_t nextValueNumber;
 118
 119       Expression::ExpressionOpcode getOpcode(BinaryOperator* BO);
 120       Expression::ExpressionOpcode getOpcode(CmpInst* C);
 121       Expression::ExpressionOpcode getOpcode(CastInst* C);
 122       Expression create_expression(BinaryOperator* BO);
 123       Expression create_expression(CmpInst* C);
 124       Expression create_expression(ShuffleVectorInst* V);
 125       Expression create_expression(ExtractElementInst* C);
 126       Expression create_expression(InsertElementInst* V);
 127       Expression create_expression(SelectInst* V);
 128       Expression create_expression(CastInst* C);
 129       Expression create_expression(GetElementPtrInst* G);
 130     public:
 131       ValueTable() { nextValueNumber = 1; }
 132       uint32_t lookup_or_add(Value* V);
 133       uint32_t lookup(Value* V) const;
 134       void add(Value* V, uint32_t num);
 135       void clear();
 136       void erase(Value* v);
 137       unsigned size();
 138   };
 139 }
 140
 141 //===----------------------------------------------------------------------===//
 142 //                     ValueTable Internal Functions
 143 //===----------------------------------------------------------------------===//
 144 ValueTable::Expression::ExpressionOpcode
 145                              ValueTable::getOpcode(BinaryOperator* BO) {
 146   switch(BO->getOpcode()) {
 147     case Instruction::Add:
 148       return Expression::ADD;
 149     case Instruction::Sub:
 150       return Expression::SUB;
 151     case Instruction::Mul:
 152       return Expression::MUL;
 153     case Instruction::UDiv:
 154       return Expression::UDIV;
 155     case Instruction::SDiv:
 156       return Expression::SDIV;
 157     case Instruction::FDiv:
 158       return Expression::FDIV;
 159     case Instruction::URem:
 160       return Expression::UREM;
 161     case Instruction::SRem:
 162       return Expression::SREM;
 163     case Instruction::FRem:
 164       return Expression::FREM;
 165     case Instruction::Shl:
 166       return Expression::SHL;
 167     case Instruction::LShr:
 168       return Expression::LSHR;
 169     case Instruction::AShr:
 170       return Expression::ASHR;
 171     case Instruction::And:
 172       return Expression::AND;
 173     case Instruction::Or:
 174       return Expression::OR;
 175     case Instruction::Xor:
 176       return Expression::XOR;
 177
 178     // THIS SHOULD NEVER HAPPEN
 179     default:
 180       assert(0 && "Binary operator with unknown opcode?");
 181       return Expression::ADD;
 182   }
 183 }
 184
 185 ValueTable::Expression::ExpressionOpcode ValueTable::getOpcode(CmpInst* C) {
 186   if (C->getOpcode() == Instruction::ICmp) {
 187     switch (C->getPredicate()) {
 188       case ICmpInst::ICMP_EQ:
 189         return Expression::ICMPEQ;
 190       case ICmpInst::ICMP_NE:
 191         return Expression::ICMPNE;
 192       case ICmpInst::ICMP_UGT:
 193         return Expression::ICMPUGT;
 194       case ICmpInst::ICMP_UGE:
 195         return Expression::ICMPUGE;
 196       case ICmpInst::ICMP_ULT:
 197         return Expression::ICMPULT;
 198       case ICmpInst::ICMP_ULE:
 199         return Expression::ICMPULE;
 200       case ICmpInst::ICMP_SGT:
 201         return Expression::ICMPSGT;
 202       case ICmpInst::ICMP_SGE:
 203         return Expression::ICMPSGE;
 204       case ICmpInst::ICMP_SLT:
 205         return Expression::ICMPSLT;
 206       case ICmpInst::ICMP_SLE:
 207         return Expression::ICMPSLE;
 208
 209       // THIS SHOULD NEVER HAPPEN
 210       default:
 211         assert(0 && "Comparison with unknown predicate?");
 212         return Expression::ICMPEQ;
 213     }
 214   } else {
 215     switch (C->getPredicate()) {
 216       case FCmpInst::FCMP_OEQ:
 217         return Expression::FCMPOEQ;
 218       case FCmpInst::FCMP_OGT:
 219         return Expression::FCMPOGT;
 220       case FCmpInst::FCMP_OGE:
 221         return Expression::FCMPOGE;
 222       case FCmpInst::FCMP_OLT:
 223         return Expression::FCMPOLT;
 224       case FCmpInst::FCMP_OLE:
 225         return Expression::FCMPOLE;
 226       case FCmpInst::FCMP_ONE:
 227         return Expression::FCMPONE;
 228       case FCmpInst::FCMP_ORD:
 229         return Expression::FCMPORD;
 230       case FCmpInst::FCMP_UNO:
 231         return Expression::FCMPUNO;
 232       case FCmpInst::FCMP_UEQ:
 233         return Expression::FCMPUEQ;
 234       case FCmpInst::FCMP_UGT:
 235         return Expression::FCMPUGT;
 236       case FCmpInst::FCMP_UGE:
 237         return Expression::FCMPUGE;
 238       case FCmpInst::FCMP_ULT:
 239         return Expression::FCMPULT;
 240       case FCmpInst::FCMP_ULE:
 241         return Expression::FCMPULE;
 242       case FCmpInst::FCMP_UNE:
 243         return Expression::FCMPUNE;
 244
 245       // THIS SHOULD NEVER HAPPEN
 246       default:
 247         assert(0 && "Comparison with unknown predicate?");
 248         return Expression::FCMPOEQ;
 249     }
 250   }
 251 }
 252
 253 ValueTable::Expression::ExpressionOpcode
 254                              ValueTable::getOpcode(CastInst* C) {
 255   switch(C->getOpcode()) {
 256     case Instruction::Trunc:
 257       return Expression::TRUNC;
 258     case Instruction::ZExt:
 259       return Expression::ZEXT;
 260     case Instruction::SExt:
 261       return Expression::SEXT;
 262     case Instruction::FPToUI:
 263       return Expression::FPTOUI;
 264     case Instruction::FPToSI:
 265       return Expression::FPTOSI;
 266     case Instruction::UIToFP:
 267       return Expression::UITOFP;
 268     case Instruction::SIToFP:
 269       return Expression::SITOFP;
 270     case Instruction::FPTrunc:
 271       return Expression::FPTRUNC;
 272     case Instruction::FPExt:
 273       return Expression::FPEXT;
 274     case Instruction::PtrToInt:
 275       return Expression::PTRTOINT;
 276     case Instruction::IntToPtr:
 277       return Expression::INTTOPTR;
 278     case Instruction::BitCast:
 279       return Expression::BITCAST;
 280
 281     // THIS SHOULD NEVER HAPPEN
 282     default:
 283       assert(0 && "Cast operator with unknown opcode?");
 284       return Expression::BITCAST;
 285   }
 286 }
 287
 288 ValueTable::Expression ValueTable::create_expression(BinaryOperator* BO) {
 289   Expression e;
 290
 291   e.firstVN = lookup_or_add(BO->getOperand(0));
 292   e.secondVN = lookup_or_add(BO->getOperand(1));
 293   e.thirdVN = 0;
 294   e.type = BO->getType();
 295   e.opcode = getOpcode(BO);
 296
 297   return e;
 298 }
 299
 300 ValueTable::Expression ValueTable::create_expression(CmpInst* C) {
 301   Expression e;
 302
 303   e.firstVN = lookup_or_add(C->getOperand(0));
 304   e.secondVN = lookup_or_add(C->getOperand(1));
 305   e.thirdVN = 0;
 306   e.type = C->getType();
 307   e.opcode = getOpcode(C);
 308
 309   return e;
 310 }
 311
 312 ValueTable::Expression ValueTable::create_expression(CastInst* C) {
 313   Expression e;
 314
 315   e.firstVN = lookup_or_add(C->getOperand(0));
 316   e.secondVN = 0;
 317   e.thirdVN = 0;
 318   e.type = C->getType();
 319   e.opcode = getOpcode(C);
 320
 321   return e;
 322 }
 323
 324 ValueTable::Expression ValueTable::create_expression(ShuffleVectorInst* S) {
 325   Expression e;
 326
 327   e.firstVN = lookup_or_add(S->getOperand(0));
 328   e.secondVN = lookup_or_add(S->getOperand(1));
 329   e.thirdVN = lookup_or_add(S->getOperand(2));
 330   e.type = S->getType();
 331   e.opcode = Expression::SHUFFLE;
 332
 333   return e;
 334 }
 335
 336 ValueTable::Expression ValueTable::create_expression(ExtractElementInst* E) {
 337   Expression e;
 338
 339   e.firstVN = lookup_or_add(E->getOperand(0));
 340   e.secondVN = lookup_or_add(E->getOperand(1));
 341   e.thirdVN = 0;
 342   e.type = E->getType();
 343   e.opcode = Expression::EXTRACT;
 344
 345   return e;
 346 }
 347
 348 ValueTable::Expression ValueTable::create_expression(InsertElementInst* I) {
 349   Expression e;
 350
 351   e.firstVN = lookup_or_add(I->getOperand(0));
 352   e.secondVN = lookup_or_add(I->getOperand(1));
 353   e.thirdVN = lookup_or_add(I->getOperand(2));
 354   e.type = I->getType();
 355   e.opcode = Expression::INSERT;
 356
 357   return e;
 358 }
 359
 360 ValueTable::Expression ValueTable::create_expression(SelectInst* I) {
 361   Expression e;
 362
 363   e.firstVN = lookup_or_add(I->getCondition());
 364   e.secondVN = lookup_or_add(I->getTrueValue());
 365   e.thirdVN = lookup_or_add(I->getFalseValue());
 366   e.type = I->getType();
 367   e.opcode = Expression::SELECT;
 368
 369   return e;
 370 }
 371
 372 ValueTable::Expression ValueTable::create_expression(GetElementPtrInst* G) {
 373   Expression e;
 374
 375   e.firstVN = lookup_or_add(G->getPointerOperand());
 376   e.secondVN = 0;
 377   e.thirdVN = 0;
 378   e.type = G->getType();
 379   e.opcode = Expression::SELECT;
 380
 381   for (GetElementPtrInst::op_iterator I = G->idx_begin(), E = G->idx_end();
 382        I != E; ++I)
 383     e.varargs.push_back(lookup_or_add(*I));
 384
 385   return e;
 386 }
 387
 388 //===----------------------------------------------------------------------===//
 389 //                     ValueTable External Functions
 390 //===----------------------------------------------------------------------===//
 391
 392 /// lookup_or_add - Returns the value number for the specified value, assigning
 393 /// it a new number if it did not have one before.
 394 uint32_t ValueTable::lookup_or_add(Value* V) {
 395   DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
 396   if (VI != valueNumbering.end())
 397     return VI->second;
 398
 399
 400   if (BinaryOperator* BO = dyn_cast<BinaryOperator>(V)) {
 401     Expression e = create_expression(BO);
 402
 403     std::map<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 404     if (EI != expressionNumbering.end()) {
 405       valueNumbering.insert(std::make_pair(V, EI->second));
 406       return EI->second;
 407     } else {
 408       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 409       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 410
 411       return nextValueNumber++;
 412     }
 413   } else if (CmpInst* C = dyn_cast<CmpInst>(V)) {
 414     Expression e = create_expression(C);
 415
 416     std::map<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 417     if (EI != expressionNumbering.end()) {
 418       valueNumbering.insert(std::make_pair(V, EI->second));
 419       return EI->second;
 420     } else {
 421       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 422       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 423
 424       return nextValueNumber++;
 425     }
 426   } else if (ShuffleVectorInst* U = dyn_cast<ShuffleVectorInst>(V)) {
 427     Expression e = create_expression(U);
 428
 429     std::map<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 430     if (EI != expressionNumbering.end()) {
 431       valueNumbering.insert(std::make_pair(V, EI->second));
 432       return EI->second;
 433     } else {
 434       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 435       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 436
 437       return nextValueNumber++;
 438     }
 439   } else if (ExtractElementInst* U = dyn_cast<ExtractElementInst>(V)) {
 440     Expression e = create_expression(U);
 441
 442     std::map<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 443     if (EI != expressionNumbering.end()) {
 444       valueNumbering.insert(std::make_pair(V, EI->second));
 445       return EI->second;
 446     } else {
 447       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 448       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 449
 450       return nextValueNumber++;
 451     }
 452   } else if (InsertElementInst* U = dyn_cast<InsertElementInst>(V)) {
 453     Expression e = create_expression(U);
 454
 455     std::map<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 456     if (EI != expressionNumbering.end()) {
 457       valueNumbering.insert(std::make_pair(V, EI->second));
 458       return EI->second;
 459     } else {
 460       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 461       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 462
 463       return nextValueNumber++;
 464     }
 465   } else if (SelectInst* U = dyn_cast<SelectInst>(V)) {
 466     Expression e = create_expression(U);
 467
 468     std::map<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 469     if (EI != expressionNumbering.end()) {
 470       valueNumbering.insert(std::make_pair(V, EI->second));
 471       return EI->second;
 472     } else {
 473       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 474       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 475
 476       return nextValueNumber++;
 477     }
 478   } else if (CastInst* U = dyn_cast<CastInst>(V)) {
 479     Expression e = create_expression(U);
 480
 481     std::map<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 482     if (EI != expressionNumbering.end()) {
 483       valueNumbering.insert(std::make_pair(V, EI->second));
 484       return EI->second;
 485     } else {
 486       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 487       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 488
 489       return nextValueNumber++;
 490     }
 491   } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(V)) {
 492     Expression e = create_expression(U);
 493
 494     std::map<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
 495     if (EI != expressionNumbering.end()) {
 496       valueNumbering.insert(std::make_pair(V, EI->second));
 497       return EI->second;
 498     } else {
 499       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
 500       valueNumbering.insert(std::make_pair(V, nextValueNumber));
 501
 502       return nextValueNumber++;
 503     }
 504   } else {
 505     valueNumbering.insert(std::make_pair(V, nextValueNumber));
 506     return nextValueNumber++;
 507   }
 508 }
 509
 510 /// lookup - Returns the value number of the specified value. Fails if
 511 /// the value has not yet been numbered.
 512 uint32_t ValueTable::lookup(Value* V) const {
 513   DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
 514   if (VI != valueNumbering.end())
 515     return VI->second;
 516   else
 517     assert(0 && "Value not numbered?");
 518
 519   return 0;
 520 }
 521
 522 /// add - Add the specified value with the given value number, removing
 523 /// its old number, if any
 524 void ValueTable::add(Value* V, uint32_t num) {
 525   DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
 526   if (VI != valueNumbering.end())
 527     valueNumbering.erase(VI);
 528   valueNumbering.insert(std::make_pair(V, num));
 529 }
 530
 531 /// clear - Remove all entries from the ValueTable
 532 void ValueTable::clear() {
 533   valueNumbering.clear();
 534   expressionNumbering.clear();
 535   nextValueNumber = 1;
 536 }
 537
 538 /// erase - Remove a value from the value numbering
 539 void ValueTable::erase(Value* V) {
 540   valueNumbering.erase(V);
 541 }
 542
 543 /// size - Return the number of assigned value numbers
 544 unsigned ValueTable::size() {
 545   // NOTE: zero is never assigned
 546   return nextValueNumber;
 547 }
 548
 549 //===----------------------------------------------------------------------===//
 550 //                       ValueNumberedSet Class
 551 //===----------------------------------------------------------------------===//
 552
 553 class ValueNumberedSet {
 554   private:
 555     SmallPtrSet<Value*, 8> contents;
 556     BitVector numbers;
 557   public:
 558     ValueNumberedSet() { numbers.resize(1); }
 559     ValueNumberedSet(const ValueNumberedSet& other) {
 560       numbers = other.numbers;
 561       contents = other.contents;
 562     }
 563
 564     typedef SmallPtrSet<Value*, 8>::iterator iterator;
 565
 566     iterator begin() { return contents.begin(); }
 567     iterator end() { return contents.end(); }
 568
 569     bool insert(Value* v) { return contents.insert(v); }
 570     void insert(iterator I, iterator E) { contents.insert(I, E); }
 571     void erase(Value* v) { contents.erase(v); }
 572     unsigned count(Value* v) { return contents.count(v); }
 573     size_t size() { return contents.size(); }
 574
 575     void set(unsigned i)  {
 576       if (i >= numbers.size())
 577         numbers.resize(i+1);
 578
 579       numbers.set(i);
 580     }
 581
 582     void operator=(const ValueNumberedSet& other) {
 583       contents = other.contents;
 584       numbers = other.numbers;
 585     }
 586
 587     void reset(unsigned i)  {
 588       if (i < numbers.size())
 589         numbers.reset(i);
 590     }
 591
 592     bool test(unsigned i)  {
 593       if (i >= numbers.size())
 594         return false;
 595
 596       return numbers.test(i);
 597     }
 598
 599     void clear() {
 600       contents.clear();
 601       numbers.clear();
 602     }
 603 };
 604
 605 //===----------------------------------------------------------------------===//
 606 //                         GVNPRE Pass
 607 //===----------------------------------------------------------------------===//
 608
 609 namespace {
 610
 611   class VISIBILITY_HIDDEN GVNPRE : public FunctionPass {
 612     bool runOnFunction(Function &F);
 613   public:
 614     static char ID; // Pass identification, replacement for typeid
 615     GVNPRE() : FunctionPass((intptr_t)&ID) { }
 616
 617   private:
 618     ValueTable VN;
 619     std::vector<Instruction*> createdExpressions;
 620
 621     DenseMap<BasicBlock*, ValueNumberedSet> availableOut;
 622     DenseMap<BasicBlock*, ValueNumberedSet> anticipatedIn;
 623     DenseMap<BasicBlock*, ValueNumberedSet> generatedPhis;
 624
 625     // This transformation requires dominator postdominator info
 626     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 627       AU.setPreservesCFG();
 628       AU.addRequiredID(BreakCriticalEdgesID);
 629       AU.addRequired<UnifyFunctionExitNodes>();
 630       AU.addRequired<DominatorTree>();
 631     }
 632
 633     // Helper fuctions
 634     // FIXME: eliminate or document these better
 635     void dump(ValueNumberedSet& s) const ;
 636     void clean(ValueNumberedSet& set) ;
 637     Value* find_leader(ValueNumberedSet& vals, uint32_t v) ;
 638     Value* phi_translate(Value* V, BasicBlock* pred, BasicBlock* succ) ;
 639     void phi_translate_set(ValueNumberedSet& anticIn, BasicBlock* pred,
 640                            BasicBlock* succ, ValueNumberedSet& out) ;
 641
 642     void topo_sort(ValueNumberedSet& set,
 643                    std::vector<Value*>& vec) ;
 644
 645     void cleanup() ;
 646     bool elimination() ;
 647
 648     void val_insert(ValueNumberedSet& s, Value* v) ;
 649     void val_replace(ValueNumberedSet& s, Value* v) ;
 650     bool dependsOnInvoke(Value* V) ;
 651     void buildsets_availout(BasicBlock::iterator I,
 652                             ValueNumberedSet& currAvail,
 653                             ValueNumberedSet& currPhis,
 654                             ValueNumberedSet& currExps,
 655                             SmallPtrSet<Value*, 16>& currTemps) ;
 656     bool buildsets_anticout(BasicBlock* BB,
 657                             ValueNumberedSet& anticOut,
 658                             std::set<BasicBlock*>& visited) ;
 659     unsigned buildsets_anticin(BasicBlock* BB,
 660                            ValueNumberedSet& anticOut,
 661                            ValueNumberedSet& currExps,
 662                            SmallPtrSet<Value*, 16>& currTemps,
 663                            std::set<BasicBlock*>& visited) ;
 664     void buildsets(Function& F) ;
 665
 666     void insertion_pre(Value* e, BasicBlock* BB,
 667                        std::map<BasicBlock*, Value*>& avail,
 668                       std::map<BasicBlock*,ValueNumberedSet>& new_set) ;
 669     unsigned insertion_mergepoint(std::vector<Value*>& workList,
 670                                   df_iterator<DomTreeNode*>& D,
 671                       std::map<BasicBlock*, ValueNumberedSet>& new_set) ;
 672     bool insertion(Function& F) ;
 673
 674   };
 675
 676   char GVNPRE::ID = 0;
 677
 678 }
 679
 680 // createGVNPREPass - The public interface to this file...
 681 FunctionPass *llvm::createGVNPREPass() { return new GVNPRE(); }
 682
 683 RegisterPass<GVNPRE> X("gvnpre",
 684                        "Global Value Numbering/Partial Redundancy Elimination");
 685
 686
 687 STATISTIC(NumInsertedVals, "Number of values inserted");
 688 STATISTIC(NumInsertedPhis, "Number of PHI nodes inserted");
 689 STATISTIC(NumEliminated, "Number of redundant instructions eliminated");
 690
 691 /// find_leader - Given a set and a value number, return the first
 692 /// element of the set with that value number, or 0 if no such element
 693 /// is present
 694 Value* GVNPRE::find_leader(ValueNumberedSet& vals, uint32_t v) {
 695   if (!vals.test(v))
 696     return 0;
 697
 698   for (ValueNumberedSet::iterator I = vals.begin(), E = vals.end();
 699        I != E; ++I)
 700     if (v == VN.lookup(*I))
 701       return *I;
 702
 703   assert(0 && "No leader found, but present bit is set?");
 704   return 0;
 705 }
 706
 707 /// val_insert - Insert a value into a set only if there is not a value
 708 /// with the same value number already in the set
 709 void GVNPRE::val_insert(ValueNumberedSet& s, Value* v) {
 710   uint32_t num = VN.lookup(v);
 711   if (!s.test(num))
 712     s.insert(v);
 713 }
 714
 715 /// val_replace - Insert a value into a set, replacing any values already in
 716 /// the set that have the same value number
 717 void GVNPRE::val_replace(ValueNumberedSet& s, Value* v) {
 718   uint32_t num = VN.lookup(v);
 719   Value* leader = find_leader(s, num);
 720   if (leader != 0)
 721     s.erase(leader);
 722   s.insert(v);
 723   s.set(num);
 724 }
 725
 726 /// phi_translate - Given a value, its parent block, and a predecessor of its
 727 /// parent, translate the value into legal for the predecessor block.  This
 728 /// means translating its operands (and recursively, their operands) through
 729 /// any phi nodes in the parent into values available in the predecessor
 730 Value* GVNPRE::phi_translate(Value* V, BasicBlock* pred, BasicBlock* succ) {
 731   if (V == 0)
 732     return 0;
 733
 734   // Unary Operations
 735   if (CastInst* U = dyn_cast<CastInst>(V)) {
 736     Value* newOp1 = 0;
 737     if (isa<Instruction>(U->getOperand(0)))
 738       newOp1 = phi_translate(U->getOperand(0), pred, succ);
 739     else
 740       newOp1 = U->getOperand(0);
 741
 742     if (newOp1 == 0)
 743       return 0;
 744
 745     if (newOp1 != U->getOperand(0)) {
 746       Instruction* newVal = 0;
 747       if (CastInst* C = dyn_cast<CastInst>(U))
 748         newVal = CastInst::create(C->getOpcode(),
 749                                   newOp1, C->getType(),
 750                                   C->getName()+".expr");
 751
 752       uint32_t v = VN.lookup_or_add(newVal);
 753
 754       Value* leader = find_leader(availableOut[pred], v);
 755       if (leader == 0) {
 756         createdExpressions.push_back(newVal);
 757         return newVal;
 758       } else {
 759         VN.erase(newVal);
 760         delete newVal;
 761         return leader;
 762       }
 763     }
 764
 765   // Binary Operations
 766   } if (isa<BinaryOperator>(V) || isa<CmpInst>(V) ||
 767       isa<ExtractElementInst>(V)) {
 768     User* U = cast<User>(V);
 769
 770     Value* newOp1 = 0;
 771     if (isa<Instruction>(U->getOperand(0)))
 772       newOp1 = phi_translate(U->getOperand(0), pred, succ);
 773     else
 774       newOp1 = U->getOperand(0);
 775
 776     if (newOp1 == 0)
 777       return 0;
 778
 779     Value* newOp2 = 0;
 780     if (isa<Instruction>(U->getOperand(1)))
 781       newOp2 = phi_translate(U->getOperand(1), pred, succ);
 782     else
 783       newOp2 = U->getOperand(1);
 784
 785     if (newOp2 == 0)
 786       return 0;
 787
 788     if (newOp1 != U->getOperand(0) || newOp2 != U->getOperand(1)) {
 789       Instruction* newVal = 0;
 790       if (BinaryOperator* BO = dyn_cast<BinaryOperator>(U))
 791         newVal = BinaryOperator::create(BO->getOpcode(),
 792                                         newOp1, newOp2,
 793                                         BO->getName()+".expr");
 794       else if (CmpInst* C = dyn_cast<CmpInst>(U))
 795         newVal = CmpInst::create(C->getOpcode(),
 796                                  C->getPredicate(),
 797                                  newOp1, newOp2,
 798                                  C->getName()+".expr");
 799       else if (ExtractElementInst* E = dyn_cast<ExtractElementInst>(U))
 800         newVal = new ExtractElementInst(newOp1, newOp2, E->getName()+".expr");
 801
 802       uint32_t v = VN.lookup_or_add(newVal);
 803
 804       Value* leader = find_leader(availableOut[pred], v);
 805       if (leader == 0) {
 806         createdExpressions.push_back(newVal);
 807         return newVal;
 808       } else {
 809         VN.erase(newVal);
 810         delete newVal;
 811         return leader;
 812       }
 813     }
 814
 815   // Ternary Operations
 816   } else if (isa<ShuffleVectorInst>(V) || isa<InsertElementInst>(V) ||
 817              isa<SelectInst>(V)) {
 818     User* U = cast<User>(V);
 819
 820     Value* newOp1 = 0;
 821     if (isa<Instruction>(U->getOperand(0)))
 822       newOp1 = phi_translate(U->getOperand(0), pred, succ);
 823     else
 824       newOp1 = U->getOperand(0);
 825
 826     if (newOp1 == 0)
 827       return 0;
 828
 829     Value* newOp2 = 0;
 830     if (isa<Instruction>(U->getOperand(1)))
 831       newOp2 = phi_translate(U->getOperand(1), pred, succ);
 832     else
 833       newOp2 = U->getOperand(1);
 834
 835     if (newOp2 == 0)
 836       return 0;
 837
 838     Value* newOp3 = 0;
 839     if (isa<Instruction>(U->getOperand(2)))
 840       newOp3 = phi_translate(U->getOperand(2), pred, succ);
 841     else
 842       newOp3 = U->getOperand(2);
 843
 844     if (newOp3 == 0)
 845       return 0;
 846
 847     if (newOp1 != U->getOperand(0) ||
 848         newOp2 != U->getOperand(1) ||
 849         newOp3 != U->getOperand(2)) {
 850       Instruction* newVal = 0;
 851       if (ShuffleVectorInst* S = dyn_cast<ShuffleVectorInst>(U))
 852         newVal = new ShuffleVectorInst(newOp1, newOp2, newOp3,
 853                                        S->getName()+".expr");
 854       else if (InsertElementInst* I = dyn_cast<InsertElementInst>(U))
 855         newVal = new InsertElementInst(newOp1, newOp2, newOp3,
 856                                        I->getName()+".expr");
 857       else if (SelectInst* I = dyn_cast<SelectInst>(U))
 858         newVal = new SelectInst(newOp1, newOp2, newOp3, I->getName()+".expr");
 859
 860       uint32_t v = VN.lookup_or_add(newVal);
 861
 862       Value* leader = find_leader(availableOut[pred], v);
 863       if (leader == 0) {
 864         createdExpressions.push_back(newVal);
 865         return newVal;
 866       } else {
 867         VN.erase(newVal);
 868         delete newVal;
 869         return leader;
 870       }
 871     }
 872
 873   // Varargs operators
 874   } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(V)) {
 875     Value* newOp1 = 0;
 876     if (isa<Instruction>(U->getPointerOperand()))
 877       newOp1 = phi_translate(U->getPointerOperand(), pred, succ);
 878     else
 879       newOp1 = U->getPointerOperand();
 880
 881     if (newOp1 == 0)
 882       return 0;
 883
 884     bool changed_idx = false;
 885     std::vector<Value*> newIdx;
 886     for (GetElementPtrInst::op_iterator I = U->idx_begin(), E = U->idx_end();
 887          I != E; ++I)
 888       if (isa<Instruction>(*I)) {
 889         Value* newVal = phi_translate(*I, pred, succ);
 890         newIdx.push_back(newVal);
 891         if (newVal != *I)
 892           changed_idx = true;
 893       } else {
 894         newIdx.push_back(*I);
 895       }
 896
 897     if (newOp1 != U->getPointerOperand() || changed_idx) {
 898       Instruction* newVal = new GetElementPtrInst(newOp1,
 899                                        &newIdx[0], newIdx.size(),
 900                                        U->getName()+".expr");
 901
 902       uint32_t v = VN.lookup_or_add(newVal);
 903
 904       Value* leader = find_leader(availableOut[pred], v);
 905       if (leader == 0) {
 906         createdExpressions.push_back(newVal);
 907         return newVal;
 908       } else {
 909         VN.erase(newVal);
 910         delete newVal;
 911         return leader;
 912       }
 913     }
 914
 915   // PHI Nodes
 916   } else if (PHINode* P = dyn_cast<PHINode>(V)) {
 917     if (P->getParent() == succ)
 918       return P->getIncomingValueForBlock(pred);
 919   }
 920
 921   return V;
 922 }
 923
 924 /// phi_translate_set - Perform phi translation on every element of a set
 925 void GVNPRE::phi_translate_set(ValueNumberedSet& anticIn,
 926                               BasicBlock* pred, BasicBlock* succ,
 927                               ValueNumberedSet& out) {
 928   for (ValueNumberedSet::iterator I = anticIn.begin(),
 929        E = anticIn.end(); I != E; ++I) {
 930     Value* V = phi_translate(*I, pred, succ);
 931     if (V != 0 && !out.test(VN.lookup_or_add(V))) {
 932       out.insert(V);
 933       out.set(VN.lookup(V));
 934     }
 935   }
 936 }
 937
 938 /// dependsOnInvoke - Test if a value has an phi node as an operand, any of
 939 /// whose inputs is an invoke instruction.  If this is true, we cannot safely
 940 /// PRE the instruction or anything that depends on it.
 941 bool GVNPRE::dependsOnInvoke(Value* V) {
 942   if (PHINode* p = dyn_cast<PHINode>(V)) {
 943     for (PHINode::op_iterator I = p->op_begin(), E = p->op_end(); I != E; ++I)
 944       if (isa<InvokeInst>(*I))
 945         return true;
 946     return false;
 947   } else {
 948     return false;
 949   }
 950 }
 951
 952 /// clean - Remove all non-opaque values from the set whose operands are not
 953 /// themselves in the set, as well as all values that depend on invokes (see
 954 /// above)
 955 void GVNPRE::clean(ValueNumberedSet& set) {
 956   std::vector<Value*> worklist;
 957   worklist.reserve(set.size());
 958   topo_sort(set, worklist);
 959
 960   for (unsigned i = 0; i < worklist.size(); ++i) {
 961     Value* v = worklist[i];
 962
 963     // Handle unary ops
 964     if (CastInst* U = dyn_cast<CastInst>(v)) {
 965       bool lhsValid = !isa<Instruction>(U->getOperand(0));
 966       lhsValid |= set.test(VN.lookup(U->getOperand(0)));
 967       if (lhsValid)
 968         lhsValid = !dependsOnInvoke(U->getOperand(0));
 969
 970       if (!lhsValid) {
 971         set.erase(U);
 972         set.reset(VN.lookup(U));
 973       }
 974
 975     // Handle binary ops
 976     } else if (isa<BinaryOperator>(v) || isa<CmpInst>(v) ||
 977         isa<ExtractElementInst>(v)) {
 978       User* U = cast<User>(v);
 979
 980       bool lhsValid = !isa<Instruction>(U->getOperand(0));
 981       lhsValid |= set.test(VN.lookup(U->getOperand(0)));
 982       if (lhsValid)
 983         lhsValid = !dependsOnInvoke(U->getOperand(0));
 984
 985       bool rhsValid = !isa<Instruction>(U->getOperand(1));
 986       rhsValid |= set.test(VN.lookup(U->getOperand(1)));
 987       if (rhsValid)
 988         rhsValid = !dependsOnInvoke(U->getOperand(1));
 989
 990       if (!lhsValid || !rhsValid) {
 991         set.erase(U);
 992         set.reset(VN.lookup(U));
 993       }
 994
 995     // Handle ternary ops
 996     } else if (isa<ShuffleVectorInst>(v) || isa<InsertElementInst>(v) ||
 997                isa<SelectInst>(v)) {
 998       User* U = cast<User>(v);
 999
1000       bool lhsValid = !isa<Instruction>(U->getOperand(0));
1001       lhsValid |= set.test(VN.lookup(U->getOperand(0)));
1002       if (lhsValid)
1003         lhsValid = !dependsOnInvoke(U->getOperand(0));
1004
1005       bool rhsValid = !isa<Instruction>(U->getOperand(1));
1006       rhsValid |= set.test(VN.lookup(U->getOperand(1)));
1007       if (rhsValid)
1008         rhsValid = !dependsOnInvoke(U->getOperand(1));
1009
1010       bool thirdValid = !isa<Instruction>(U->getOperand(2));
1011       thirdValid |= set.test(VN.lookup(U->getOperand(2)));
1012       if (thirdValid)
1013         thirdValid = !dependsOnInvoke(U->getOperand(2));
1014
1015       if (!lhsValid || !rhsValid || !thirdValid) {
1016         set.erase(U);
1017         set.reset(VN.lookup(U));
1018       }
1019
1020     // Handle varargs ops
1021     } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(v)) {
1022       bool ptrValid = !isa<Instruction>(U->getPointerOperand());
1023       ptrValid |= set.test(VN.lookup(U->getPointerOperand()));
1024       if (ptrValid)
1025         ptrValid = !dependsOnInvoke(U->getPointerOperand());
1026
1027       bool varValid = true;
1028       for (GetElementPtrInst::op_iterator I = U->idx_begin(), E = U->idx_end();
1029            I != E; ++I)
1030         if (varValid) {
1031           varValid &= !isa<Instruction>(*I) || set.test(VN.lookup(*I));
1032           varValid &= !dependsOnInvoke(*I);
1033         }
1034
1035       if (!ptrValid || !varValid) {
1036         set.erase(U);
1037         set.reset(VN.lookup(U));
1038       }
1039     }
1040   }
1041 }
1042
1043 /// topo_sort - Given a set of values, sort them by topological
1044 /// order into the provided vector.
1045 void GVNPRE::topo_sort(ValueNumberedSet& set, std::vector<Value*>& vec) {
1046   SmallPtrSet<Value*, 16> visited;
1047   std::vector<Value*> stack;
1048   for (ValueNumberedSet::iterator I = set.begin(), E = set.end();
1049        I != E; ++I) {
1050     if (visited.count(*I) == 0)
1051       stack.push_back(*I);
1052
1053     while (!stack.empty()) {
1054       Value* e = stack.back();
1055
1056       // Handle unary ops
1057       if (CastInst* U = dyn_cast<CastInst>(e)) {
1058         Value* l = find_leader(set, VN.lookup(U->getOperand(0)));
1059
1060         if (l != 0 && isa<Instruction>(l) &&
1061             visited.count(l) == 0)
1062           stack.push_back(l);
1063         else {
1064           vec.push_back(e);
1065           visited.insert(e);
1066           stack.pop_back();
1067         }
1068
1069       // Handle binary ops
1070       } else if (isa<BinaryOperator>(e) || isa<CmpInst>(e) ||
1071           isa<ExtractElementInst>(e)) {
1072         User* U = cast<User>(e);
1073         Value* l = find_leader(set, VN.lookup(U->getOperand(0)));
1074         Value* r = find_leader(set, VN.lookup(U->getOperand(1)));
1075
1076         if (l != 0 && isa<Instruction>(l) &&
1077             visited.count(l) == 0)
1078           stack.push_back(l);
1079         else if (r != 0 && isa<Instruction>(r) &&
1080                  visited.count(r) == 0)
1081           stack.push_back(r);
1082         else {
1083           vec.push_back(e);
1084           visited.insert(e);
1085           stack.pop_back();
1086         }
1087
1088       // Handle ternary ops
1089       } else if (isa<InsertElementInst>(e) || isa<ShuffleVectorInst>(e) ||
1090                  isa<SelectInst>(e)) {
1091         User* U = cast<User>(e);
1092         Value* l = find_leader(set, VN.lookup(U->getOperand(0)));
1093         Value* r = find_leader(set, VN.lookup(U->getOperand(1)));
1094         Value* m = find_leader(set, VN.lookup(U->getOperand(2)));
1095
1096         if (l != 0 && isa<Instruction>(l) &&
1097             visited.count(l) == 0)
1098           stack.push_back(l);
1099         else if (r != 0 && isa<Instruction>(r) &&
1100                  visited.count(r) == 0)
1101           stack.push_back(r);
1102         else if (m != 0 && isa<Instruction>(m) &&
1103                  visited.count(m) == 0)
1104           stack.push_back(m);
1105         else {
1106           vec.push_back(e);
1107           visited.insert(e);
1108           stack.pop_back();
1109         }
1110
1111       // Handle vararg ops
1112       } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(e)) {
1113         Value* p = find_leader(set, VN.lookup(U->getPointerOperand()));
1114
1115         if (p != 0 && isa<Instruction>(p) &&
1116             visited.count(p) == 0)
1117           stack.push_back(p);
1118         else {
1119           bool push_va = false;
1120           for (GetElementPtrInst::op_iterator I = U->idx_begin(),
1121                E = U->idx_end(); I != E; ++I) {
1122             Value * v = find_leader(set, VN.lookup(*I));
1123             if (v != 0 && isa<Instruction>(v) && visited.count(v) == 0) {
1124               stack.push_back(v);
1125               push_va = true;
1126             }
1127           }
1128
1129           if (!push_va) {
1130             vec.push_back(e);
1131             visited.insert(e);
1132             stack.pop_back();
1133           }
1134         }
1135
1136       // Handle opaque ops
1137       } else {
1138         visited.insert(e);
1139         vec.push_back(e);
1140         stack.pop_back();
1141       }
1142     }
1143
1144     stack.clear();
1145   }
1146 }
1147
1148 /// dump - Dump a set of values to standard error
1149 void GVNPRE::dump(ValueNumberedSet& s) const {
1150   DOUT << "{ ";
1151   for (ValueNumberedSet::iterator I = s.begin(), E = s.end();
1152        I != E; ++I) {
1153     DOUT << "" << VN.lookup(*I) << ": ";
1154     DEBUG((*I)->dump());
1155   }
1156   DOUT << "}\n\n";
1157 }
1158
1159 /// elimination - Phase 3 of the main algorithm.  Perform full redundancy
1160 /// elimination by walking the dominator tree and removing any instruction that
1161 /// is dominated by another instruction with the same value number.
1162 bool GVNPRE::elimination() {
1163   bool changed_function = false;
1164
1165   std::vector<std::pair<Instruction*, Value*> > replace;
1166   std::vector<Instruction*> erase;
1167
1168   DominatorTree& DT = getAnalysis<DominatorTree>();
1169
1170   for (df_iterator<DomTreeNode*> DI = df_begin(DT.getRootNode()),
1171          E = df_end(DT.getRootNode()); DI != E; ++DI) {
1172     BasicBlock* BB = DI->getBlock();
1173
1174     for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();
1175          BI != BE; ++BI) {
1176
1177       if (isa<BinaryOperator>(BI) || isa<CmpInst>(BI) ||
1178           isa<ShuffleVectorInst>(BI) || isa<InsertElementInst>(BI) ||
1179           isa<ExtractElementInst>(BI) || isa<SelectInst>(BI) ||
1180           isa<CastInst>(BI) || isa<GetElementPtrInst>(BI)) {
1181
1182         if (availableOut[BB].test(VN.lookup(BI)) && !availableOut[BB].count(BI)) {
1183           Value *leader = find_leader(availableOut[BB], VN.lookup(BI));
1184           if (Instruction* Instr = dyn_cast<Instruction>(leader))
1185             if (Instr->getParent() != 0 && Instr != BI) {
1186               replace.push_back(std::make_pair(BI, leader));
1187               erase.push_back(BI);
1188               ++NumEliminated;
1189             }
1190         }
1191       }
1192     }
1193   }
1194
1195   while (!replace.empty()) {
1196     std::pair<Instruction*, Value*> rep = replace.back();
1197     replace.pop_back();
1198     rep.first->replaceAllUsesWith(rep.second);
1199     changed_function = true;
1200   }
1201
1202   for (std::vector<Instruction*>::iterator I = erase.begin(), E = erase.end();
1203        I != E; ++I)
1204      (*I)->eraseFromParent();
1205
1206   return changed_function;
1207 }
1208
1209 /// cleanup - Delete any extraneous values that were created to represent
1210 /// expressions without leaders.
1211 void GVNPRE::cleanup() {
1212   while (!createdExpressions.empty()) {
1213     Instruction* I = createdExpressions.back();
1214     createdExpressions.pop_back();
1215
1216     delete I;
1217   }
1218 }
1219
1220 /// buildsets_availout - When calculating availability, handle an instruction
1221 /// by inserting it into the appropriate sets
1222 void GVNPRE::buildsets_availout(BasicBlock::iterator I,
1223                                 ValueNumberedSet& currAvail,
1224                                 ValueNumberedSet& currPhis,
1225                                 ValueNumberedSet& currExps,
1226                                 SmallPtrSet<Value*, 16>& currTemps) {
1227   // Handle PHI nodes
1228   if (PHINode* p = dyn_cast<PHINode>(I)) {
1229     unsigned num = VN.lookup_or_add(p);
1230
1231     currPhis.insert(p);
1232     currPhis.set(num);
1233
1234   // Handle unary ops
1235   } else if (CastInst* U = dyn_cast<CastInst>(I)) {
1236     Value* leftValue = U->getOperand(0);
1237
1238     unsigned num = VN.lookup_or_add(U);
1239
1240     if (isa<Instruction>(leftValue))
1241       if (!currExps.test(VN.lookup(leftValue))) {
1242         currExps.insert(leftValue);
1243         currExps.set(VN.lookup(leftValue));
1244       }
1245
1246     if (!currExps.test(num)) {
1247       currExps.insert(U);
1248       currExps.set(num);
1249     }
1250
1251   // Handle binary ops
1252   } else if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
1253              isa<ExtractElementInst>(I)) {
1254     User* U = cast<User>(I);
1255     Value* leftValue = U->getOperand(0);
1256     Value* rightValue = U->getOperand(1);
1257
1258     unsigned num = VN.lookup_or_add(U);
1259
1260     if (isa<Instruction>(leftValue))
1261       if (!currExps.test(VN.lookup(leftValue))) {
1262         currExps.insert(leftValue);
1263         currExps.set(VN.lookup(leftValue));
1264       }
1265
1266     if (isa<Instruction>(rightValue))
1267       if (!currExps.test(VN.lookup(rightValue))) {
1268         currExps.insert(rightValue);
1269         currExps.set(VN.lookup(rightValue));
1270       }
1271
1272     if (!currExps.test(num)) {
1273       currExps.insert(U);
1274       currExps.set(num);
1275     }
1276
1277   // Handle ternary ops
1278   } else if (isa<InsertElementInst>(I) || isa<ShuffleVectorInst>(I) ||
1279              isa<SelectInst>(I)) {
1280     User* U = cast<User>(I);
1281     Value* leftValue = U->getOperand(0);
1282     Value* rightValue = U->getOperand(1);
1283     Value* thirdValue = U->getOperand(2);
1284
1285     VN.lookup_or_add(U);
1286
1287     unsigned num = VN.lookup_or_add(U);
1288
1289     if (isa<Instruction>(leftValue))
1290       if (!currExps.test(VN.lookup(leftValue))) {
1291         currExps.insert(leftValue);
1292         currExps.set(VN.lookup(leftValue));
1293       }
1294     if (isa<Instruction>(rightValue))
1295       if (!currExps.test(VN.lookup(rightValue))) {
1296         currExps.insert(rightValue);
1297         currExps.set(VN.lookup(rightValue));
1298       }
1299     if (isa<Instruction>(thirdValue))
1300       if (!currExps.test(VN.lookup(thirdValue))) {
1301         currExps.insert(thirdValue);
1302         currExps.set(VN.lookup(thirdValue));
1303       }
1304
1305     if (!currExps.test(num)) {
1306       currExps.insert(U);
1307       currExps.set(num);
1308     }
1309
1310   // Handle vararg ops
1311   } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(I)) {
1312     Value* ptrValue = U->getPointerOperand();
1313
1314     VN.lookup_or_add(U);
1315
1316     unsigned num = VN.lookup_or_add(U);
1317
1318     if (isa<Instruction>(ptrValue))
1319       if (!currExps.test(VN.lookup(ptrValue))) {
1320         currExps.insert(ptrValue);
1321         currExps.set(VN.lookup(ptrValue));
1322       }
1323
1324     for (GetElementPtrInst::op_iterator OI = U->idx_begin(), OE = U->idx_end();
1325          OI != OE; ++OI)
1326       if (isa<Instruction>(*OI) && !currExps.test(VN.lookup(*OI))) {
1327         currExps.insert(*OI);
1328         currExps.set(VN.lookup(*OI));
1329       }
1330
1331     if (!currExps.test(VN.lookup(U))) {
1332       currExps.insert(U);
1333       currExps.set(num);
1334     }
1335
1336   // Handle opaque ops
1337   } else if (!I->isTerminator()){
1338     VN.lookup_or_add(I);
1339
1340     currTemps.insert(I);
1341   }
1342
1343   if (!I->isTerminator())
1344     if (!currAvail.test(VN.lookup(I))) {
1345       currAvail.insert(I);
1346       currAvail.set(VN.lookup(I));
1347     }
1348 }
1349
1350 /// buildsets_anticout - When walking the postdom tree, calculate the ANTIC_OUT
1351 /// set as a function of the ANTIC_IN set of the block's predecessors
1352 bool GVNPRE::buildsets_anticout(BasicBlock* BB,
1353                                 ValueNumberedSet& anticOut,
1354                                 std::set<BasicBlock*>& visited) {
1355   if (BB->getTerminator()->getNumSuccessors() == 1) {
1356     if (BB->getTerminator()->getSuccessor(0) != BB &&
1357         visited.count(BB->getTerminator()->getSuccessor(0)) == 0) {
1358       return true;
1359     }
1360     else {
1361       phi_translate_set(anticipatedIn[BB->getTerminator()->getSuccessor(0)],
1362                         BB,  BB->getTerminator()->getSuccessor(0), anticOut);
1363     }
1364   } else if (BB->getTerminator()->getNumSuccessors() > 1) {
1365     BasicBlock* first = BB->getTerminator()->getSuccessor(0);
1366     for (ValueNumberedSet::iterator I = anticipatedIn[first].begin(),
1367          E = anticipatedIn[first].end(); I != E; ++I) {
1368       anticOut.insert(*I);
1369       anticOut.set(VN.lookup(*I));
1370     }
1371
1372     for (unsigned i = 1; i < BB->getTerminator()->getNumSuccessors(); ++i) {
1373       BasicBlock* currSucc = BB->getTerminator()->getSuccessor(i);
1374       ValueNumberedSet& succAnticIn = anticipatedIn[currSucc];
1375
1376       std::vector<Value*> temp;
1377
1378       for (ValueNumberedSet::iterator I = anticOut.begin(),
1379            E = anticOut.end(); I != E; ++I)
1380         if (!succAnticIn.test(VN.lookup(*I)))
1381           temp.push_back(*I);
1382
1383       for (std::vector<Value*>::iterator I = temp.begin(), E = temp.end();
1384            I != E; ++I) {
1385         anticOut.erase(*I);
1386         anticOut.reset(VN.lookup(*I));
1387       }
1388     }
1389   }
1390
1391   return false;
1392 }
1393
1394 /// buildsets_anticin - Walk the postdom tree, calculating ANTIC_OUT for
1395 /// each block.  ANTIC_IN is then a function of ANTIC_OUT and the GEN
1396 /// sets populated in buildsets_availout
1397 unsigned GVNPRE::buildsets_anticin(BasicBlock* BB,
1398                                ValueNumberedSet& anticOut,
1399                                ValueNumberedSet& currExps,
1400                                SmallPtrSet<Value*, 16>& currTemps,
1401                                std::set<BasicBlock*>& visited) {
1402   ValueNumberedSet& anticIn = anticipatedIn[BB];
1403   unsigned old = anticIn.size();
1404
1405   bool defer = buildsets_anticout(BB, anticOut, visited);
1406   if (defer)
1407     return 0;
1408
1409   anticIn.clear();
1410
1411   for (ValueNumberedSet::iterator I = anticOut.begin(),
1412        E = anticOut.end(); I != E; ++I) {
1413     anticIn.insert(*I);
1414     anticIn.set(VN.lookup(*I));
1415   }
1416   for (ValueNumberedSet::iterator I = currExps.begin(),
1417        E = currExps.end(); I != E; ++I) {
1418     if (!anticIn.test(VN.lookup(*I))) {
1419       anticIn.insert(*I);
1420       anticIn.set(VN.lookup(*I));
1421     }
1422   }
1423
1424   for (SmallPtrSet<Value*, 16>::iterator I = currTemps.begin(),
1425        E = currTemps.end(); I != E; ++I) {
1426     anticIn.erase(*I);
1427     anticIn.reset(VN.lookup(*I));
1428   }
1429
1430   clean(anticIn);
1431   anticOut.clear();
1432
1433   if (old != anticIn.size())
1434     return 2;
1435   else
1436     return 1;
1437 }
1438
1439 /// buildsets - Phase 1 of the main algorithm.  Construct the AVAIL_OUT
1440 /// and the ANTIC_IN sets.
1441 void GVNPRE::buildsets(Function& F) {
1442   std::map<BasicBlock*, ValueNumberedSet> generatedExpressions;
1443   std::map<BasicBlock*, SmallPtrSet<Value*, 16> > generatedTemporaries;
1444
1445   DominatorTree &DT = getAnalysis<DominatorTree>();
1446
1447   // Phase 1, Part 1: calculate AVAIL_OUT
1448
1449   // Top-down walk of the dominator tree
1450   for (df_iterator<DomTreeNode*> DI = df_begin(DT.getRootNode()),
1451          E = df_end(DT.getRootNode()); DI != E; ++DI) {
1452
1453     // Get the sets to update for this block
1454     ValueNumberedSet& currExps = generatedExpressions[DI->getBlock()];
1455     ValueNumberedSet& currPhis = generatedPhis[DI->getBlock()];
1456     SmallPtrSet<Value*, 16>& currTemps = generatedTemporaries[DI->getBlock()];
1457     ValueNumberedSet& currAvail = availableOut[DI->getBlock()];
1458
1459     BasicBlock* BB = DI->getBlock();
1460
1461     // A block inherits AVAIL_OUT from its dominator
1462     if (DI->getIDom() != 0)
1463       currAvail = availableOut[DI->getIDom()->getBlock()];
1464
1465     for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();
1466          BI != BE; ++BI)
1467       buildsets_availout(BI, currAvail, currPhis, currExps,
1468                          currTemps);
1469
1470   }
1471
1472   // Phase 1, Part 2: calculate ANTIC_IN
1473
1474   std::set<BasicBlock*> visited;
1475   SmallPtrSet<BasicBlock*, 4> block_changed;
1476   for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI)
1477     block_changed.insert(FI);
1478
1479   bool changed = true;
1480   unsigned iterations = 0;
1481
1482   while (changed) {
1483     changed = false;
1484     ValueNumberedSet anticOut;
1485
1486     // Postorder walk of the CFG
1487     for (po_iterator<BasicBlock*> BBI = po_begin(&F.getEntryBlock()),
1488          BBE = po_end(&F.getEntryBlock()); BBI != BBE; ++BBI) {
1489       BasicBlock* BB = *BBI;
1490
1491       if (block_changed.count(BB) != 0) {
1492         unsigned ret = buildsets_anticin(BB, anticOut,generatedExpressions[BB],
1493                                          generatedTemporaries[BB], visited);
1494
1495         if (ret == 0) {
1496           changed = true;
1497           continue;
1498         } else {
1499           visited.insert(BB);
1500
1501           if (ret == 2)
1502            for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
1503                  PI != PE; ++PI) {
1504               block_changed.insert(*PI);
1505            }
1506           else
1507             block_changed.erase(BB);
1508
1509           changed |= (ret == 2);
1510         }
1511       }
1512     }
1513
1514     iterations++;
1515   }
1516 }
1517
1518 /// insertion_pre - When a partial redundancy has been identified, eliminate it
1519 /// by inserting appropriate values into the predecessors and a phi node in
1520 /// the main block
1521 void GVNPRE::insertion_pre(Value* e, BasicBlock* BB,
1522                            std::map<BasicBlock*, Value*>& avail,
1523                     std::map<BasicBlock*, ValueNumberedSet>& new_sets) {
1524   for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE; ++PI) {
1525     Value* e2 = avail[*PI];
1526     if (!availableOut[*PI].test(VN.lookup(e2))) {
1527       User* U = cast<User>(e2);
1528
1529       Value* s1 = 0;
1530       if (isa<BinaryOperator>(U->getOperand(0)) ||
1531           isa<CmpInst>(U->getOperand(0)) ||
1532           isa<ShuffleVectorInst>(U->getOperand(0)) ||
1533           isa<ExtractElementInst>(U->getOperand(0)) ||
1534           isa<InsertElementInst>(U->getOperand(0)) ||
1535           isa<SelectInst>(U->getOperand(0)) ||
1536           isa<CastInst>(U->getOperand(0)) ||
1537           isa<GetElementPtrInst>(U->getOperand(0)))
1538         s1 = find_leader(availableOut[*PI], VN.lookup(U->getOperand(0)));
1539       else
1540         s1 = U->getOperand(0);
1541
1542       Value* s2 = 0;
1543
1544       if (isa<BinaryOperator>(U) ||
1545           isa<CmpInst>(U) ||
1546           isa<ShuffleVectorInst>(U) ||
1547           isa<ExtractElementInst>(U) ||
1548           isa<InsertElementInst>(U) ||
1549           isa<SelectInst>(U))
1550         if (isa<BinaryOperator>(U->getOperand(1)) ||
1551             isa<CmpInst>(U->getOperand(1)) ||
1552             isa<ShuffleVectorInst>(U->getOperand(1)) ||
1553             isa<ExtractElementInst>(U->getOperand(1)) ||
1554             isa<InsertElementInst>(U->getOperand(1)) ||
1555             isa<SelectInst>(U->getOperand(1)) ||
1556             isa<CastInst>(U->getOperand(1)) ||
1557             isa<GetElementPtrInst>(U->getOperand(1))) {
1558           s2 = find_leader(availableOut[*PI], VN.lookup(U->getOperand(1)));
1559         } else {
1560           s2 = U->getOperand(1);
1561         }
1562
1563       // Ternary Operators
1564       Value* s3 = 0;
1565       if (isa<ShuffleVectorInst>(U) ||
1566           isa<InsertElementInst>(U) ||
1567           isa<SelectInst>(U))
1568         if (isa<BinaryOperator>(U->getOperand(2)) ||
1569             isa<CmpInst>(U->getOperand(2)) ||
1570             isa<ShuffleVectorInst>(U->getOperand(2)) ||
1571             isa<ExtractElementInst>(U->getOperand(2)) ||
1572             isa<InsertElementInst>(U->getOperand(2)) ||
1573             isa<SelectInst>(U->getOperand(2)) ||
1574             isa<CastInst>(U->getOperand(2)) ||
1575             isa<GetElementPtrInst>(U->getOperand(2))) {
1576           s3 = find_leader(availableOut[*PI], VN.lookup(U->getOperand(2)));
1577         } else {
1578           s3 = U->getOperand(2);
1579         }
1580
1581       // Vararg operators
1582       std::vector<Value*> sVarargs;
1583       if (GetElementPtrInst* G = dyn_cast<GetElementPtrInst>(U)) {
1584         for (GetElementPtrInst::op_iterator OI = G->idx_begin(),
1585              OE = G->idx_end(); OI != OE; ++OI) {
1586           if (isa<BinaryOperator>(*OI) ||
1587               isa<CmpInst>(*OI) ||
1588               isa<ShuffleVectorInst>(*OI) ||
1589               isa<ExtractElementInst>(*OI) ||
1590               isa<InsertElementInst>(*OI) ||
1591               isa<SelectInst>(*OI) ||
1592               isa<CastInst>(*OI) ||
1593               isa<GetElementPtrInst>(*OI)) {
1594             sVarargs.push_back(find_leader(availableOut[*PI],
1595                                VN.lookup(*OI)));
1596           } else {
1597             sVarargs.push_back(*OI);
1598           }
1599         }
1600       }
1601
1602       Value* newVal = 0;
1603       if (BinaryOperator* BO = dyn_cast<BinaryOperator>(U))
1604         newVal = BinaryOperator::create(BO->getOpcode(), s1, s2,
1605                                         BO->getName()+".gvnpre",
1606                                         (*PI)->getTerminator());
1607       else if (CmpInst* C = dyn_cast<CmpInst>(U))
1608         newVal = CmpInst::create(C->getOpcode(), C->getPredicate(), s1, s2,
1609                                  C->getName()+".gvnpre",
1610                                  (*PI)->getTerminator());
1611       else if (ShuffleVectorInst* S = dyn_cast<ShuffleVectorInst>(U))
1612         newVal = new ShuffleVectorInst(s1, s2, s3, S->getName()+".gvnpre",
1613                                        (*PI)->getTerminator());
1614       else if (InsertElementInst* S = dyn_cast<InsertElementInst>(U))
1615         newVal = new InsertElementInst(s1, s2, s3, S->getName()+".gvnpre",
1616                                        (*PI)->getTerminator());
1617       else if (ExtractElementInst* S = dyn_cast<ExtractElementInst>(U))
1618         newVal = new ExtractElementInst(s1, s2, S->getName()+".gvnpre",
1619                                         (*PI)->getTerminator());
1620       else if (SelectInst* S = dyn_cast<SelectInst>(U))
1621         newVal = new SelectInst(s1, s2, s3, S->getName()+".gvnpre",
1622                                 (*PI)->getTerminator());
1623       else if (CastInst* C = dyn_cast<CastInst>(U))
1624         newVal = CastInst::create(C->getOpcode(), s1, C->getType(),
1625                                   C->getName()+".gvnpre",
1626                                   (*PI)->getTerminator());
1627       else if (GetElementPtrInst* G = dyn_cast<GetElementPtrInst>(U))
1628         newVal = new GetElementPtrInst(s1, &sVarargs[0], sVarargs.size(),
1629                                        G->getName()+".gvnpre",
1630                                        (*PI)->getTerminator());
1631
1632
1633       VN.add(newVal, VN.lookup(U));
1634
1635       ValueNumberedSet& predAvail = availableOut[*PI];
1636       val_replace(predAvail, newVal);
1637       val_replace(new_sets[*PI], newVal);
1638       predAvail.set(VN.lookup(newVal));
1639
1640       std::map<BasicBlock*, Value*>::iterator av = avail.find(*PI);
1641       if (av != avail.end())
1642         avail.erase(av);
1643       avail.insert(std::make_pair(*PI, newVal));
1644
1645       ++NumInsertedVals;
1646     }
1647   }
1648
1649   PHINode* p = 0;
1650
1651   for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE; ++PI) {
1652     if (p == 0)
1653       p = new PHINode(avail[*PI]->getType(), "gvnpre-join", BB->begin());
1654
1655     p->addIncoming(avail[*PI], *PI);
1656   }
1657
1658   VN.add(p, VN.lookup(e));
1659   val_replace(availableOut[BB], p);
1660   availableOut[BB].set(VN.lookup(e));
1661   generatedPhis[BB].insert(p);
1662   generatedPhis[BB].set(VN.lookup(e));
1663   new_sets[BB].insert(p);
1664   new_sets[BB].set(VN.lookup(e));
1665
1666   ++NumInsertedPhis;
1667 }
1668
1669 /// insertion_mergepoint - When walking the dom tree, check at each merge
1670 /// block for the possibility of a partial redundancy.  If present, eliminate it
1671 unsigned GVNPRE::insertion_mergepoint(std::vector<Value*>& workList,
1672                                       df_iterator<DomTreeNode*>& D,
1673                     std::map<BasicBlock*, ValueNumberedSet >& new_sets) {
1674   bool changed_function = false;
1675   bool new_stuff = false;
1676
1677   BasicBlock* BB = D->getBlock();
1678   for (unsigned i = 0; i < workList.size(); ++i) {
1679     Value* e = workList[i];
1680
1681     if (isa<BinaryOperator>(e) || isa<CmpInst>(e) ||
1682         isa<ExtractElementInst>(e) || isa<InsertElementInst>(e) ||
1683         isa<ShuffleVectorInst>(e) || isa<SelectInst>(e) || isa<CastInst>(e) ||
1684         isa<GetElementPtrInst>(e)) {
1685       if (availableOut[D->getIDom()->getBlock()].test(VN.lookup(e)))
1686         continue;
1687
1688       std::map<BasicBlock*, Value*> avail;
1689       bool by_some = false;
1690       bool all_same = true;
1691       Value * first_s = 0;
1692
1693       for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;
1694            ++PI) {
1695         Value *e2 = phi_translate(e, *PI, BB);
1696         Value *e3 = find_leader(availableOut[*PI], VN.lookup(e2));
1697
1698         if (e3 == 0) {
1699           std::map<BasicBlock*, Value*>::iterator av = avail.find(*PI);
1700           if (av != avail.end())
1701             avail.erase(av);
1702           avail.insert(std::make_pair(*PI, e2));
1703           all_same = false;
1704         } else {
1705           std::map<BasicBlock*, Value*>::iterator av = avail.find(*PI);
1706           if (av != avail.end())
1707             avail.erase(av);
1708           avail.insert(std::make_pair(*PI, e3));
1709
1710           by_some = true;
1711           if (first_s == 0)
1712             first_s = e3;
1713           else if (first_s != e3)
1714             all_same = false;
1715         }
1716       }
1717
1718       if (by_some && !all_same &&
1719           !generatedPhis[BB].test(VN.lookup(e))) {
1720         insertion_pre(e, BB, avail, new_sets);
1721
1722         changed_function = true;
1723         new_stuff = true;
1724       }
1725     }
1726   }
1727
1728   unsigned retval = 0;
1729   if (changed_function)
1730     retval += 1;
1731   if (new_stuff)
1732     retval += 2;
1733
1734   return retval;
1735 }
1736
1737 /// insert - Phase 2 of the main algorithm.  Walk the dominator tree looking for
1738 /// merge points.  When one is found, check for a partial redundancy.  If one is
1739 /// present, eliminate it.  Repeat this walk until no changes are made.
1740 bool GVNPRE::insertion(Function& F) {
1741   bool changed_function = false;
1742
1743   DominatorTree &DT = getAnalysis<DominatorTree>();
1744
1745   std::map<BasicBlock*, ValueNumberedSet> new_sets;
1746   bool new_stuff = true;
1747   while (new_stuff) {
1748     new_stuff = false;
1749     for (df_iterator<DomTreeNode*> DI = df_begin(DT.getRootNode()),
1750          E = df_end(DT.getRootNode()); DI != E; ++DI) {
1751       BasicBlock* BB = DI->getBlock();
1752
1753       if (BB == 0)
1754         continue;
1755
1756       ValueNumberedSet& availOut = availableOut[BB];
1757       ValueNumberedSet& anticIn = anticipatedIn[BB];
1758
1759       // Replace leaders with leaders inherited from dominator
1760       if (DI->getIDom() != 0) {
1761         ValueNumberedSet& dom_set = new_sets[DI->getIDom()->getBlock()];
1762         for (ValueNumberedSet::iterator I = dom_set.begin(),
1763              E = dom_set.end(); I != E; ++I) {
1764           val_replace(new_sets[BB], *I);
1765           val_replace(availOut, *I);
1766         }
1767       }
1768
1769       // If there is more than one predecessor...
1770       if (pred_begin(BB) != pred_end(BB) && ++pred_begin(BB) != pred_end(BB)) {
1771         std::vector<Value*> workList;
1772         workList.reserve(anticIn.size());
1773         topo_sort(anticIn, workList);
1774
1775         unsigned result = insertion_mergepoint(workList, DI, new_sets);
1776         if (result & 1)
1777           changed_function = true;
1778         if (result & 2)
1779           new_stuff = true;
1780       }
1781     }
1782   }
1783
1784   return changed_function;
1785 }
1786
1787 // GVNPRE::runOnFunction - This is the main transformation entry point for a
1788 // function.
1789 //
1790 bool GVNPRE::runOnFunction(Function &F) {
1791   // Clean out global sets from any previous functions
1792   VN.clear();
1793   createdExpressions.clear();
1794   availableOut.clear();
1795   anticipatedIn.clear();
1796   generatedPhis.clear();
1797
1798   bool changed_function = false;
1799
1800   // Phase 1: BuildSets
1801   // This phase calculates the AVAIL_OUT and ANTIC_IN sets
1802   buildsets(F);
1803
1804   // Phase 2: Insert
1805   // This phase inserts values to make partially redundant values
1806   // fully redundant
1807   changed_function |= insertion(F);
1808
1809   // Phase 3: Eliminate
1810   // This phase performs trivial full redundancy elimination
1811   changed_function |= elimination();
1812
1813   // Phase 4: Cleanup
1814   // This phase cleans up values that were created solely
1815   // as leaders for expressions
1816   cleanup();
1817
1818   return changed_function;
1819 }