lib/Transforms/Scalar/EarlyCSE.cpp

   1 //===- EarlyCSE.cpp - Simple and fast CSE pass ----------------------------===//
   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 a simple dominator tree walk that eliminates trivially
  11 // redundant instructions.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Transforms/Scalar/EarlyCSE.h"
  16 #include "llvm/ADT/Hashing.h"
  17 #include "llvm/ADT/ScopedHashTable.h"
  18 #include "llvm/ADT/Statistic.h"
  19 #include "llvm/Analysis/AssumptionCache.h"
  20 #include "llvm/Analysis/InstructionSimplify.h"
  21 #include "llvm/Analysis/TargetTransformInfo.h"
  22 #include "llvm/IR/DataLayout.h"
  23 #include "llvm/IR/Dominators.h"
  24 #include "llvm/IR/Instructions.h"
  25 #include "llvm/IR/IntrinsicInst.h"
  26 #include "llvm/IR/PatternMatch.h"
  27 #include "llvm/Pass.h"
  28 #include "llvm/Support/Debug.h"
  29 #include "llvm/Support/RecyclingAllocator.h"
  30 #include "llvm/Analysis/TargetLibraryInfo.h"
  31 #include "llvm/Transforms/Scalar.h"
  32 #include "llvm/Transforms/Utils/Local.h"
  33 #include <deque>
  34 using namespace llvm;
  35 using namespace llvm::PatternMatch;
  36
  37 #define DEBUG_TYPE "early-cse"
  38
  39 STATISTIC(NumSimplify, "Number of instructions simplified or DCE'd");
  40 STATISTIC(NumCSE,      "Number of instructions CSE'd");
  41 STATISTIC(NumCSELoad,  "Number of load instructions CSE'd");
  42 STATISTIC(NumCSECall,  "Number of call instructions CSE'd");
  43 STATISTIC(NumDSE,      "Number of trivial dead stores removed");
  44
  45 //===----------------------------------------------------------------------===//
  46 // SimpleValue
  47 //===----------------------------------------------------------------------===//
  48
  49 namespace {
  50 /// \brief Struct representing the available values in the scoped hash table.
  51 struct SimpleValue {
  52   Instruction *Inst;
  53
  54   SimpleValue(Instruction *I) : Inst(I) {
  55     assert((isSentinel() || canHandle(I)) && "Inst can't be handled!");
  56   }
  57
  58   bool isSentinel() const {
  59     return Inst == DenseMapInfo<Instruction *>::getEmptyKey() ||
  60            Inst == DenseMapInfo<Instruction *>::getTombstoneKey();
  61   }
  62
  63   static bool canHandle(Instruction *Inst) {
  64     // This can only handle non-void readnone functions.
  65     if (CallInst *CI = dyn_cast<CallInst>(Inst))
  66       return CI->doesNotAccessMemory() && !CI->getType()->isVoidTy();
  67     return isa<CastInst>(Inst) || isa<BinaryOperator>(Inst) ||
  68            isa<GetElementPtrInst>(Inst) || isa<CmpInst>(Inst) ||
  69            isa<SelectInst>(Inst) || isa<ExtractElementInst>(Inst) ||
  70            isa<InsertElementInst>(Inst) || isa<ShuffleVectorInst>(Inst) ||
  71            isa<ExtractValueInst>(Inst) || isa<InsertValueInst>(Inst);
  72   }
  73 };
  74 }
  75
  76 namespace llvm {
  77 template <> struct DenseMapInfo<SimpleValue> {
  78   static inline SimpleValue getEmptyKey() {
  79     return DenseMapInfo<Instruction *>::getEmptyKey();
  80   }
  81   static inline SimpleValue getTombstoneKey() {
  82     return DenseMapInfo<Instruction *>::getTombstoneKey();
  83   }
  84   static unsigned getHashValue(SimpleValue Val);
  85   static bool isEqual(SimpleValue LHS, SimpleValue RHS);
  86 };
  87 }
  88
  89 unsigned DenseMapInfo<SimpleValue>::getHashValue(SimpleValue Val) {
  90   Instruction *Inst = Val.Inst;
  91   // Hash in all of the operands as pointers.
  92   if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Inst)) {
  93     Value *LHS = BinOp->getOperand(0);
  94     Value *RHS = BinOp->getOperand(1);
  95     if (BinOp->isCommutative() && BinOp->getOperand(0) > BinOp->getOperand(1))
  96       std::swap(LHS, RHS);
  97
  98     if (isa<OverflowingBinaryOperator>(BinOp)) {
  99       // Hash the overflow behavior
 100       unsigned Overflow =
 101           BinOp->hasNoSignedWrap() * OverflowingBinaryOperator::NoSignedWrap |
 102           BinOp->hasNoUnsignedWrap() *
 103               OverflowingBinaryOperator::NoUnsignedWrap;
 104       return hash_combine(BinOp->getOpcode(), Overflow, LHS, RHS);
 105     }
 106
 107     return hash_combine(BinOp->getOpcode(), LHS, RHS);
 108   }
 109
 110   if (CmpInst *CI = dyn_cast<CmpInst>(Inst)) {
 111     Value *LHS = CI->getOperand(0);
 112     Value *RHS = CI->getOperand(1);
 113     CmpInst::Predicate Pred = CI->getPredicate();
 114     if (Inst->getOperand(0) > Inst->getOperand(1)) {
 115       std::swap(LHS, RHS);
 116       Pred = CI->getSwappedPredicate();
 117     }
 118     return hash_combine(Inst->getOpcode(), Pred, LHS, RHS);
 119   }
 120
 121   if (CastInst *CI = dyn_cast<CastInst>(Inst))
 122     return hash_combine(CI->getOpcode(), CI->getType(), CI->getOperand(0));
 123
 124   if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(Inst))
 125     return hash_combine(EVI->getOpcode(), EVI->getOperand(0),
 126                         hash_combine_range(EVI->idx_begin(), EVI->idx_end()));
 127
 128   if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(Inst))
 129     return hash_combine(IVI->getOpcode(), IVI->getOperand(0),
 130                         IVI->getOperand(1),
 131                         hash_combine_range(IVI->idx_begin(), IVI->idx_end()));
 132
 133   assert((isa<CallInst>(Inst) || isa<BinaryOperator>(Inst) ||
 134           isa<GetElementPtrInst>(Inst) || isa<SelectInst>(Inst) ||
 135           isa<ExtractElementInst>(Inst) || isa<InsertElementInst>(Inst) ||
 136           isa<ShuffleVectorInst>(Inst)) &&
 137          "Invalid/unknown instruction");
 138
 139   // Mix in the opcode.
 140   return hash_combine(
 141       Inst->getOpcode(),
 142       hash_combine_range(Inst->value_op_begin(), Inst->value_op_end()));
 143 }
 144
 145 bool DenseMapInfo<SimpleValue>::isEqual(SimpleValue LHS, SimpleValue RHS) {
 146   Instruction *LHSI = LHS.Inst, *RHSI = RHS.Inst;
 147
 148   if (LHS.isSentinel() || RHS.isSentinel())
 149     return LHSI == RHSI;
 150
 151   if (LHSI->getOpcode() != RHSI->getOpcode())
 152     return false;
 153   if (LHSI->isIdenticalTo(RHSI))
 154     return true;
 155
 156   // If we're not strictly identical, we still might be a commutable instruction
 157   if (BinaryOperator *LHSBinOp = dyn_cast<BinaryOperator>(LHSI)) {
 158     if (!LHSBinOp->isCommutative())
 159       return false;
 160
 161     assert(isa<BinaryOperator>(RHSI) &&
 162            "same opcode, but different instruction type?");
 163     BinaryOperator *RHSBinOp = cast<BinaryOperator>(RHSI);
 164
 165     // Check overflow attributes
 166     if (isa<OverflowingBinaryOperator>(LHSBinOp)) {
 167       assert(isa<OverflowingBinaryOperator>(RHSBinOp) &&
 168              "same opcode, but different operator type?");
 169       if (LHSBinOp->hasNoUnsignedWrap() != RHSBinOp->hasNoUnsignedWrap() ||
 170           LHSBinOp->hasNoSignedWrap() != RHSBinOp->hasNoSignedWrap())
 171         return false;
 172     }
 173
 174     // Commuted equality
 175     return LHSBinOp->getOperand(0) == RHSBinOp->getOperand(1) &&
 176            LHSBinOp->getOperand(1) == RHSBinOp->getOperand(0);
 177   }
 178   if (CmpInst *LHSCmp = dyn_cast<CmpInst>(LHSI)) {
 179     assert(isa<CmpInst>(RHSI) &&
 180            "same opcode, but different instruction type?");
 181     CmpInst *RHSCmp = cast<CmpInst>(RHSI);
 182     // Commuted equality
 183     return LHSCmp->getOperand(0) == RHSCmp->getOperand(1) &&
 184            LHSCmp->getOperand(1) == RHSCmp->getOperand(0) &&
 185            LHSCmp->getSwappedPredicate() == RHSCmp->getPredicate();
 186   }
 187
 188   return false;
 189 }
 190
 191 //===----------------------------------------------------------------------===//
 192 // CallValue
 193 //===----------------------------------------------------------------------===//
 194
 195 namespace {
 196 /// \brief Struct representing the available call values in the scoped hash
 197 /// table.
 198 struct CallValue {
 199   Instruction *Inst;
 200
 201   CallValue(Instruction *I) : Inst(I) {
 202     assert((isSentinel() || canHandle(I)) && "Inst can't be handled!");
 203   }
 204
 205   bool isSentinel() const {
 206     return Inst == DenseMapInfo<Instruction *>::getEmptyKey() ||
 207            Inst == DenseMapInfo<Instruction *>::getTombstoneKey();
 208   }
 209
 210   static bool canHandle(Instruction *Inst) {
 211     // Don't value number anything that returns void.
 212     if (Inst->getType()->isVoidTy())
 213       return false;
 214
 215     CallInst *CI = dyn_cast<CallInst>(Inst);
 216     if (!CI || !CI->onlyReadsMemory())
 217       return false;
 218     return true;
 219   }
 220 };
 221 }
 222
 223 namespace llvm {
 224 template <> struct DenseMapInfo<CallValue> {
 225   static inline CallValue getEmptyKey() {
 226     return DenseMapInfo<Instruction *>::getEmptyKey();
 227   }
 228   static inline CallValue getTombstoneKey() {
 229     return DenseMapInfo<Instruction *>::getTombstoneKey();
 230   }
 231   static unsigned getHashValue(CallValue Val);
 232   static bool isEqual(CallValue LHS, CallValue RHS);
 233 };
 234 }
 235
 236 unsigned DenseMapInfo<CallValue>::getHashValue(CallValue Val) {
 237   Instruction *Inst = Val.Inst;
 238   // Hash all of the operands as pointers and mix in the opcode.
 239   return hash_combine(
 240       Inst->getOpcode(),
 241       hash_combine_range(Inst->value_op_begin(), Inst->value_op_end()));
 242 }
 243
 244 bool DenseMapInfo<CallValue>::isEqual(CallValue LHS, CallValue RHS) {
 245   Instruction *LHSI = LHS.Inst, *RHSI = RHS.Inst;
 246   if (LHS.isSentinel() || RHS.isSentinel())
 247     return LHSI == RHSI;
 248   return LHSI->isIdenticalTo(RHSI);
 249 }
 250
 251 //===----------------------------------------------------------------------===//
 252 // EarlyCSE implementation
 253 //===----------------------------------------------------------------------===//
 254
 255 namespace {
 256 /// \brief A simple and fast domtree-based CSE pass.
 257 ///
 258 /// This pass does a simple depth-first walk over the dominator tree,
 259 /// eliminating trivially redundant instructions and using instsimplify to
 260 /// canonicalize things as it goes. It is intended to be fast and catch obvious
 261 /// cases so that instcombine and other passes are more effective. It is
 262 /// expected that a later pass of GVN will catch the interesting/hard cases.
 263 class EarlyCSE {
 264 public:
 265   Function &F;
 266   const DataLayout *DL;
 267   const TargetLibraryInfo &TLI;
 268   const TargetTransformInfo &TTI;
 269   DominatorTree &DT;
 270   AssumptionCache &AC;
 271   typedef RecyclingAllocator<
 272       BumpPtrAllocator, ScopedHashTableVal<SimpleValue, Value *>> AllocatorTy;
 273   typedef ScopedHashTable<SimpleValue, Value *, DenseMapInfo<SimpleValue>,
 274                           AllocatorTy> ScopedHTType;
 275
 276   /// \brief A scoped hash table of the current values of all of our simple
 277   /// scalar expressions.
 278   ///
 279   /// As we walk down the domtree, we look to see if instructions are in this:
 280   /// if so, we replace them with what we find, otherwise we insert them so
 281   /// that dominated values can succeed in their lookup.
 282   ScopedHTType AvailableValues;
 283
 284   /// \brief A scoped hash table of the current values of loads.
 285   ///
 286   /// This allows us to get efficient access to dominating loads when we have
 287   /// a fully redundant load.  In addition to the most recent load, we keep
 288   /// track of a generation count of the read, which is compared against the
 289   /// current generation count.  The current generation count is incremented
 290   /// after every possibly writing memory operation, which ensures that we only
 291   /// CSE loads with other loads that have no intervening store.
 292   typedef RecyclingAllocator<
 293       BumpPtrAllocator,
 294       ScopedHashTableVal<Value *, std::pair<Value *, unsigned>>>
 295       LoadMapAllocator;
 296   typedef ScopedHashTable<Value *, std::pair<Value *, unsigned>,
 297                           DenseMapInfo<Value *>, LoadMapAllocator> LoadHTType;
 298   LoadHTType AvailableLoads;
 299
 300   /// \brief A scoped hash table of the current values of read-only call
 301   /// values.
 302   ///
 303   /// It uses the same generation count as loads.
 304   typedef ScopedHashTable<CallValue, std::pair<Value *, unsigned>> CallHTType;
 305   CallHTType AvailableCalls;
 306
 307   /// \brief This is the current generation of the memory value.
 308   unsigned CurrentGeneration;
 309
 310   /// \brief Set up the EarlyCSE runner for a particular function.
 311   EarlyCSE(Function &F, const DataLayout *DL, const TargetLibraryInfo &TLI,
 312            const TargetTransformInfo &TTI, DominatorTree &DT,
 313            AssumptionCache &AC)
 314       : F(F), DL(DL), TLI(TLI), TTI(TTI), DT(DT), AC(AC), CurrentGeneration(0) {
 315   }
 316
 317   bool run();
 318
 319 private:
 320   // Almost a POD, but needs to call the constructors for the scoped hash
 321   // tables so that a new scope gets pushed on. These are RAII so that the
 322   // scope gets popped when the NodeScope is destroyed.
 323   class NodeScope {
 324   public:
 325     NodeScope(ScopedHTType &AvailableValues, LoadHTType &AvailableLoads,
 326               CallHTType &AvailableCalls)
 327         : Scope(AvailableValues), LoadScope(AvailableLoads),
 328           CallScope(AvailableCalls) {}
 329
 330   private:
 331     NodeScope(const NodeScope &) LLVM_DELETED_FUNCTION;
 332     void operator=(const NodeScope &) LLVM_DELETED_FUNCTION;
 333
 334     ScopedHTType::ScopeTy Scope;
 335     LoadHTType::ScopeTy LoadScope;
 336     CallHTType::ScopeTy CallScope;
 337   };
 338
 339   // Contains all the needed information to create a stack for doing a depth
 340   // first tranversal of the tree. This includes scopes for values, loads, and
 341   // calls as well as the generation. There is a child iterator so that the
 342   // children do not need to be store spearately.
 343   class StackNode {
 344   public:
 345     StackNode(ScopedHTType &AvailableValues, LoadHTType &AvailableLoads,
 346               CallHTType &AvailableCalls, unsigned cg, DomTreeNode *n,
 347               DomTreeNode::iterator child, DomTreeNode::iterator end)
 348         : CurrentGeneration(cg), ChildGeneration(cg), Node(n), ChildIter(child),
 349           EndIter(end), Scopes(AvailableValues, AvailableLoads, AvailableCalls),
 350           Processed(false) {}
 351
 352     // Accessors.
 353     unsigned currentGeneration() { return CurrentGeneration; }
 354     unsigned childGeneration() { return ChildGeneration; }
 355     void childGeneration(unsigned generation) { ChildGeneration = generation; }
 356     DomTreeNode *node() { return Node; }
 357     DomTreeNode::iterator childIter() { return ChildIter; }
 358     DomTreeNode *nextChild() {
 359       DomTreeNode *child = *ChildIter;
 360       ++ChildIter;
 361       return child;
 362     }
 363     DomTreeNode::iterator end() { return EndIter; }
 364     bool isProcessed() { return Processed; }
 365     void process() { Processed = true; }
 366
 367   private:
 368     StackNode(const StackNode &) LLVM_DELETED_FUNCTION;
 369     void operator=(const StackNode &) LLVM_DELETED_FUNCTION;
 370
 371     // Members.
 372     unsigned CurrentGeneration;
 373     unsigned ChildGeneration;
 374     DomTreeNode *Node;
 375     DomTreeNode::iterator ChildIter;
 376     DomTreeNode::iterator EndIter;
 377     NodeScope Scopes;
 378     bool Processed;
 379   };
 380
 381   /// \brief Wrapper class to handle memory instructions, including loads,
 382   /// stores and intrinsic loads and stores defined by the target.
 383   class ParseMemoryInst {
 384   public:
 385     ParseMemoryInst(Instruction *Inst, const TargetTransformInfo &TTI)
 386         : Load(false), Store(false), Vol(false), MayReadFromMemory(false),
 387           MayWriteToMemory(false), MatchingId(-1), Ptr(nullptr) {
 388       MayReadFromMemory = Inst->mayReadFromMemory();
 389       MayWriteToMemory = Inst->mayWriteToMemory();
 390       if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
 391         MemIntrinsicInfo Info;
 392         if (!TTI.getTgtMemIntrinsic(II, Info))
 393           return;
 394         if (Info.NumMemRefs == 1) {
 395           Store = Info.WriteMem;
 396           Load = Info.ReadMem;
 397           MatchingId = Info.MatchingId;
 398           MayReadFromMemory = Info.ReadMem;
 399           MayWriteToMemory = Info.WriteMem;
 400           Vol = Info.Vol;
 401           Ptr = Info.PtrVal;
 402         }
 403       } else if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
 404         Load = true;
 405         Vol = !LI->isSimple();
 406         Ptr = LI->getPointerOperand();
 407       } else if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
 408         Store = true;
 409         Vol = !SI->isSimple();
 410         Ptr = SI->getPointerOperand();
 411       }
 412     }
 413     bool isLoad() { return Load; }
 414     bool isStore() { return Store; }
 415     bool isVolatile() { return Vol; }
 416     bool isMatchingMemLoc(const ParseMemoryInst &Inst) {
 417       return Ptr == Inst.Ptr && MatchingId == Inst.MatchingId;
 418     }
 419     bool isValid() { return Ptr != nullptr; }
 420     int getMatchingId() { return MatchingId; }
 421     Value *getPtr() { return Ptr; }
 422     bool mayReadFromMemory() { return MayReadFromMemory; }
 423     bool mayWriteToMemory() { return MayWriteToMemory; }
 424
 425   private:
 426     bool Load;
 427     bool Store;
 428     bool Vol;
 429     bool MayReadFromMemory;
 430     bool MayWriteToMemory;
 431     // For regular (non-intrinsic) loads/stores, this is set to -1. For
 432     // intrinsic loads/stores, the id is retrieved from the corresponding
 433     // field in the MemIntrinsicInfo structure.  That field contains
 434     // non-negative values only.
 435     int MatchingId;
 436     Value *Ptr;
 437   };
 438
 439   bool processNode(DomTreeNode *Node);
 440
 441   Value *getOrCreateResult(Value *Inst, Type *ExpectedType) const {
 442     if (LoadInst *LI = dyn_cast<LoadInst>(Inst))
 443       return LI;
 444     else if (StoreInst *SI = dyn_cast<StoreInst>(Inst))
 445       return SI->getValueOperand();
 446     assert(isa<IntrinsicInst>(Inst) && "Instruction not supported");
 447     return TTI.getOrCreateResultFromMemIntrinsic(cast<IntrinsicInst>(Inst),
 448                                                  ExpectedType);
 449   }
 450 };
 451 }
 452
 453 bool EarlyCSE::processNode(DomTreeNode *Node) {
 454   BasicBlock *BB = Node->getBlock();
 455
 456   // If this block has a single predecessor, then the predecessor is the parent
 457   // of the domtree node and all of the live out memory values are still current
 458   // in this block.  If this block has multiple predecessors, then they could
 459   // have invalidated the live-out memory values of our parent value.  For now,
 460   // just be conservative and invalidate memory if this block has multiple
 461   // predecessors.
 462   if (!BB->getSinglePredecessor())
 463     ++CurrentGeneration;
 464
 465   /// LastStore - Keep track of the last non-volatile store that we saw... for
 466   /// as long as there in no instruction that reads memory.  If we see a store
 467   /// to the same location, we delete the dead store.  This zaps trivial dead
 468   /// stores which can occur in bitfield code among other things.
 469   Instruction *LastStore = nullptr;
 470
 471   bool Changed = false;
 472
 473   // See if any instructions in the block can be eliminated.  If so, do it.  If
 474   // not, add them to AvailableValues.
 475   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E;) {
 476     Instruction *Inst = I++;
 477
 478     // Dead instructions should just be removed.
 479     if (isInstructionTriviallyDead(Inst, &TLI)) {
 480       DEBUG(dbgs() << "EarlyCSE DCE: " << *Inst << '\n');
 481       Inst->eraseFromParent();
 482       Changed = true;
 483       ++NumSimplify;
 484       continue;
 485     }
 486
 487     // Skip assume intrinsics, they don't really have side effects (although
 488     // they're marked as such to ensure preservation of control dependencies),
 489     // and this pass will not disturb any of the assumption's control
 490     // dependencies.
 491     if (match(Inst, m_Intrinsic<Intrinsic::assume>())) {
 492       DEBUG(dbgs() << "EarlyCSE skipping assumption: " << *Inst << '\n');
 493       continue;
 494     }
 495
 496     // If the instruction can be simplified (e.g. X+0 = X) then replace it with
 497     // its simpler value.
 498     if (Value *V = SimplifyInstruction(Inst, DL, &TLI, &DT, &AC)) {
 499       DEBUG(dbgs() << "EarlyCSE Simplify: " << *Inst << "  to: " << *V << '\n');
 500       Inst->replaceAllUsesWith(V);
 501       Inst->eraseFromParent();
 502       Changed = true;
 503       ++NumSimplify;
 504       continue;
 505     }
 506
 507     // If this is a simple instruction that we can value number, process it.
 508     if (SimpleValue::canHandle(Inst)) {
 509       // See if the instruction has an available value.  If so, use it.
 510       if (Value *V = AvailableValues.lookup(Inst)) {
 511         DEBUG(dbgs() << "EarlyCSE CSE: " << *Inst << "  to: " << *V << '\n');
 512         Inst->replaceAllUsesWith(V);
 513         Inst->eraseFromParent();
 514         Changed = true;
 515         ++NumCSE;
 516         continue;
 517       }
 518
 519       // Otherwise, just remember that this value is available.
 520       AvailableValues.insert(Inst, Inst);
 521       continue;
 522     }
 523
 524     ParseMemoryInst MemInst(Inst, TTI);
 525     // If this is a non-volatile load, process it.
 526     if (MemInst.isValid() && MemInst.isLoad()) {
 527       // Ignore volatile loads.
 528       if (MemInst.isVolatile()) {
 529         LastStore = nullptr;
 530         continue;
 531       }
 532
 533       // If we have an available version of this load, and if it is the right
 534       // generation, replace this instruction.
 535       std::pair<Value *, unsigned> InVal =
 536           AvailableLoads.lookup(MemInst.getPtr());
 537       if (InVal.first != nullptr && InVal.second == CurrentGeneration) {
 538         Value *Op = getOrCreateResult(InVal.first, Inst->getType());
 539         if (Op != nullptr) {
 540           DEBUG(dbgs() << "EarlyCSE CSE LOAD: " << *Inst
 541                        << "  to: " << *InVal.first << '\n');
 542           if (!Inst->use_empty())
 543             Inst->replaceAllUsesWith(Op);
 544           Inst->eraseFromParent();
 545           Changed = true;
 546           ++NumCSELoad;
 547           continue;
 548         }
 549       }
 550
 551       // Otherwise, remember that we have this instruction.
 552       AvailableLoads.insert(MemInst.getPtr(), std::pair<Value *, unsigned>(
 553                                                   Inst, CurrentGeneration));
 554       LastStore = nullptr;
 555       continue;
 556     }
 557
 558     // If this instruction may read from memory, forget LastStore.
 559     // Load/store intrinsics will indicate both a read and a write to
 560     // memory.  The target may override this (e.g. so that a store intrinsic
 561     // does not read  from memory, and thus will be treated the same as a
 562     // regular store for commoning purposes).
 563     if (Inst->mayReadFromMemory() &&
 564         !(MemInst.isValid() && !MemInst.mayReadFromMemory()))
 565       LastStore = nullptr;
 566
 567     // If this is a read-only call, process it.
 568     if (CallValue::canHandle(Inst)) {
 569       // If we have an available version of this call, and if it is the right
 570       // generation, replace this instruction.
 571       std::pair<Value *, unsigned> InVal = AvailableCalls.lookup(Inst);
 572       if (InVal.first != nullptr && InVal.second == CurrentGeneration) {
 573         DEBUG(dbgs() << "EarlyCSE CSE CALL: " << *Inst
 574                      << "  to: " << *InVal.first << '\n');
 575         if (!Inst->use_empty())
 576           Inst->replaceAllUsesWith(InVal.first);
 577         Inst->eraseFromParent();
 578         Changed = true;
 579         ++NumCSECall;
 580         continue;
 581       }
 582
 583       // Otherwise, remember that we have this instruction.
 584       AvailableCalls.insert(
 585           Inst, std::pair<Value *, unsigned>(Inst, CurrentGeneration));
 586       continue;
 587     }
 588
 589     // Okay, this isn't something we can CSE at all.  Check to see if it is
 590     // something that could modify memory.  If so, our available memory values
 591     // cannot be used so bump the generation count.
 592     if (Inst->mayWriteToMemory()) {
 593       ++CurrentGeneration;
 594
 595       if (MemInst.isValid() && MemInst.isStore()) {
 596         // We do a trivial form of DSE if there are two stores to the same
 597         // location with no intervening loads.  Delete the earlier store.
 598         if (LastStore) {
 599           ParseMemoryInst LastStoreMemInst(LastStore, TTI);
 600           if (LastStoreMemInst.isMatchingMemLoc(MemInst)) {
 601             DEBUG(dbgs() << "EarlyCSE DEAD STORE: " << *LastStore
 602                          << "  due to: " << *Inst << '\n');
 603             LastStore->eraseFromParent();
 604             Changed = true;
 605             ++NumDSE;
 606             LastStore = nullptr;
 607           }
 608           // fallthrough - we can exploit information about this store
 609         }
 610
 611         // Okay, we just invalidated anything we knew about loaded values.  Try
 612         // to salvage *something* by remembering that the stored value is a live
 613         // version of the pointer.  It is safe to forward from volatile stores
 614         // to non-volatile loads, so we don't have to check for volatility of
 615         // the store.
 616         AvailableLoads.insert(MemInst.getPtr(), std::pair<Value *, unsigned>(
 617                                                     Inst, CurrentGeneration));
 618
 619         // Remember that this was the last store we saw for DSE.
 620         if (!MemInst.isVolatile())
 621           LastStore = Inst;
 622       }
 623     }
 624   }
 625
 626   return Changed;
 627 }
 628
 629 bool EarlyCSE::run() {
 630   // Note, deque is being used here because there is significant performance
 631   // gains over vector when the container becomes very large due to the
 632   // specific access patterns. For more information see the mailing list
 633   // discussion on this:
 634   // http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20120116/135228.html
 635   std::deque<StackNode *> nodesToProcess;
 636
 637   bool Changed = false;
 638
 639   // Process the root node.
 640   nodesToProcess.push_back(new StackNode(
 641       AvailableValues, AvailableLoads, AvailableCalls, CurrentGeneration,
 642       DT.getRootNode(), DT.getRootNode()->begin(), DT.getRootNode()->end()));
 643
 644   // Save the current generation.
 645   unsigned LiveOutGeneration = CurrentGeneration;
 646
 647   // Process the stack.
 648   while (!nodesToProcess.empty()) {
 649     // Grab the first item off the stack. Set the current generation, remove
 650     // the node from the stack, and process it.
 651     StackNode *NodeToProcess = nodesToProcess.back();
 652
 653     // Initialize class members.
 654     CurrentGeneration = NodeToProcess->currentGeneration();
 655
 656     // Check if the node needs to be processed.
 657     if (!NodeToProcess->isProcessed()) {
 658       // Process the node.
 659       Changed |= processNode(NodeToProcess->node());
 660       NodeToProcess->childGeneration(CurrentGeneration);
 661       NodeToProcess->process();
 662     } else if (NodeToProcess->childIter() != NodeToProcess->end()) {
 663       // Push the next child onto the stack.
 664       DomTreeNode *child = NodeToProcess->nextChild();
 665       nodesToProcess.push_back(
 666           new StackNode(AvailableValues, AvailableLoads, AvailableCalls,
 667                         NodeToProcess->childGeneration(), child, child->begin(),
 668                         child->end()));
 669     } else {
 670       // It has been processed, and there are no more children to process,
 671       // so delete it and pop it off the stack.
 672       delete NodeToProcess;
 673       nodesToProcess.pop_back();
 674     }
 675   } // while (!nodes...)
 676
 677   // Reset the current generation.
 678   CurrentGeneration = LiveOutGeneration;
 679
 680   return Changed;
 681 }
 682
 683 PreservedAnalyses EarlyCSEPass::run(Function &F,
 684                                     AnalysisManager<Function> *AM) {
 685   const DataLayout *DL = F.getParent()->getDataLayout();
 686
 687   auto &TLI = AM->getResult<TargetLibraryAnalysis>(F);
 688   auto &TTI = AM->getResult<TargetIRAnalysis>(F);
 689   auto &DT = AM->getResult<DominatorTreeAnalysis>(F);
 690   auto &AC = AM->getResult<AssumptionAnalysis>(F);
 691
 692   EarlyCSE CSE(F, DL, TLI, TTI, DT, AC);
 693
 694   if (!CSE.run())
 695     return PreservedAnalyses::all();
 696
 697   // CSE preserves the dominator tree because it doesn't mutate the CFG.
 698   // FIXME: Bundle this with other CFG-preservation.
 699   PreservedAnalyses PA;
 700   PA.preserve<DominatorTreeAnalysis>();
 701   return PA;
 702 }
 703
 704 namespace {
 705 /// \brief A simple and fast domtree-based CSE pass.
 706 ///
 707 /// This pass does a simple depth-first walk over the dominator tree,
 708 /// eliminating trivially redundant instructions and using instsimplify to
 709 /// canonicalize things as it goes. It is intended to be fast and catch obvious
 710 /// cases so that instcombine and other passes are more effective. It is
 711 /// expected that a later pass of GVN will catch the interesting/hard cases.
 712 class EarlyCSELegacyPass : public FunctionPass {
 713 public:
 714   static char ID;
 715
 716   EarlyCSELegacyPass() : FunctionPass(ID) {
 717     initializeEarlyCSELegacyPassPass(*PassRegistry::getPassRegistry());
 718   }
 719
 720   bool runOnFunction(Function &F) override {
 721     if (skipOptnoneFunction(F))
 722       return false;
 723
 724     DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
 725     auto *DL = DLP ? &DLP->getDataLayout() : nullptr;
 726     auto &TLI = getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
 727     auto &TTI = getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F);
 728     auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
 729     auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
 730
 731     EarlyCSE CSE(F, DL, TLI, TTI, DT, AC);
 732
 733     return CSE.run();
 734   }
 735
 736   void getAnalysisUsage(AnalysisUsage &AU) const override {
 737     AU.addRequired<AssumptionCacheTracker>();
 738     AU.addRequired<DominatorTreeWrapperPass>();
 739     AU.addRequired<TargetLibraryInfoWrapperPass>();
 740     AU.addRequired<TargetTransformInfoWrapperPass>();
 741     AU.setPreservesCFG();
 742   }
 743 };
 744 }
 745
 746 char EarlyCSELegacyPass::ID = 0;
 747
 748 FunctionPass *llvm::createEarlyCSEPass() { return new EarlyCSELegacyPass(); }
 749
 750 INITIALIZE_PASS_BEGIN(EarlyCSELegacyPass, "early-cse", "Early CSE", false,
 751                       false)
 752 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass)
 753 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
 754 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
 755 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
 756 INITIALIZE_PASS_END(EarlyCSELegacyPass, "early-cse", "Early CSE", false, false)