add_EliminateNewDuplicatePHINodes

Author: vpykhtin

llvm/include/llvm/Transforms/Utils/Local.h

@@ -175,6 +175,22 @@ bool EliminateDuplicatePHINodes(BasicBlock *BB);
 bool EliminateDuplicatePHINodes(BasicBlock *BB,
                                 SmallPtrSetImpl<PHINode *> &ToRemove);
 
+/// Check for and eliminate duplicate PHI nodes in the block. This function is
+/// specifically designed for scenarios where new PHI nodes are inserted into
+/// the beginning of the block, such when SSAUpdaterBulk::RewriteAllUses. It
+/// compares the newly inserted PHI nodes against the existing ones and if a
+/// new PHI node is found to be a duplicate of an existing one, the new node is
+/// removed. Existing PHI nodes are left unmodified, even if they are
+/// duplicates. New nodes are also deleted if they are duplicates of each other.
+/// Similar to EliminateDuplicatePHINodes, this function assumes a consistent
+/// order for all incoming values across PHI nodes in the block. FirstExistedPN
+/// Points to the first existing PHI node in the block. Newly inserted PHI nodes
+/// should not reference one another. However, they may reference themselves or
+/// existing PHI nodes, and existing PHI nodes may reference the newly inserted
+/// PHI nodes.
+bool EliminateNewDuplicatePHINodes(BasicBlock *BB,
+                                   BasicBlock::phi_iterator FirstExistedPN);
+
 /// This function is used to do simplification of a CFG.  For example, it
 /// adjusts branches to branches to eliminate the extra hop, it eliminates
 /// unreachable basic blocks, and does other peephole optimization of the CFG.

llvm/lib/Transforms/Utils/Local.cpp

@@ -1419,65 +1419,65 @@ EliminateDuplicatePHINodesNaiveImpl(BasicBlock *BB,
   return Changed;
 }
 
-static bool
-EliminateDuplicatePHINodesSetBasedImpl(BasicBlock *BB,
-                                       SmallPtrSetImpl<PHINode *> &ToRemove) {
-  // This implementation doesn't currently consider undef operands
-  // specially. Theoretically, two phis which are identical except for
-  // one having an undef where the other doesn't could be collapsed.
+// This implementation doesn't currently consider undef operands
+// specially. Theoretically, two phis which are identical except for
+// one having an undef where the other doesn't could be collapsed.
 
-  struct PHIDenseMapInfo {
-    static PHINode *getEmptyKey() {
-      return DenseMapInfo<PHINode *>::getEmptyKey();
-    }
+struct PHIDenseMapInfo {
+  static PHINode *getEmptyKey() {
+    return DenseMapInfo<PHINode *>::getEmptyKey();
+  }
 
-    static PHINode *getTombstoneKey() {
-      return DenseMapInfo<PHINode *>::getTombstoneKey();
-    }
+  static PHINode *getTombstoneKey() {
+    return DenseMapInfo<PHINode *>::getTombstoneKey();
+  }
 
-    static bool isSentinel(PHINode *PN) {
-      return PN == getEmptyKey() || PN == getTombstoneKey();
-    }
+  static bool isSentinel(const PHINode *PN) {
+    return PN == getEmptyKey() || PN == getTombstoneKey();
+  }
 
-    // WARNING: this logic must be kept in sync with
-    //          Instruction::isIdenticalToWhenDefined()!
-    static unsigned getHashValueImpl(PHINode *PN) {
-      // Compute a hash value on the operands. Instcombine will likely have
-      // sorted them, which helps expose duplicates, but we have to check all
-      // the operands to be safe in case instcombine hasn't run.
-      return static_cast<unsigned>(hash_combine(
-          hash_combine_range(PN->value_op_begin(), PN->value_op_end()),
-          hash_combine_range(PN->block_begin(), PN->block_end())));
-    }
+  // WARNING: this logic must be kept in sync with
+  //          Instruction::isIdenticalToWhenDefined()!
+  static unsigned getHashValueImpl(const PHINode *PN) {
+    // Compute a hash value on the operands. Instcombine will likely have
+    // sorted them, which helps expose duplicates, but we have to check all
+    // the operands to be safe in case instcombine hasn't run.
+    return static_cast<unsigned>(hash_combine(
+        hash_combine_range(PN->value_op_begin(), PN->value_op_end()),
+        hash_combine_range(PN->block_begin(), PN->block_end())));
+  }
 
-    static unsigned getHashValue(PHINode *PN) {
+  static unsigned getHashValue(const PHINode *PN) {
 #ifndef NDEBUG
-      // If -phicse-debug-hash was specified, return a constant -- this
-      // will force all hashing to collide, so we'll exhaustively search
-      // the table for a match, and the assertion in isEqual will fire if
-      // there's a bug causing equal keys to hash differently.
-      if (PHICSEDebugHash)
-        return 0;
+    // If -phicse-debug-hash was specified, return a constant -- this
+    // will force all hashing to collide, so we'll exhaustively search
+    // the table for a match, and the assertion in isEqual will fire if
+    // there's a bug causing equal keys to hash differently.
+    if (PHICSEDebugHash)
+      return 0;
 #endif
-      return getHashValueImpl(PN);
-    }
+    return getHashValueImpl(PN);
+  }
 
-    static bool isEqualImpl(PHINode *LHS, PHINode *RHS) {
-      if (isSentinel(LHS) || isSentinel(RHS))
-        return LHS == RHS;
-      return LHS->isIdenticalTo(RHS);
-    }
+  static bool isEqualImpl(const PHINode *LHS, const PHINode *RHS) {
+    if (isSentinel(LHS) || isSentinel(RHS))
+      return LHS == RHS;
+    return LHS->isIdenticalTo(RHS);
+  }
 
-    static bool isEqual(PHINode *LHS, PHINode *RHS) {
-      // These comparisons are nontrivial, so assert that equality implies
-      // hash equality (DenseMap demands this as an invariant).
-      bool Result = isEqualImpl(LHS, RHS);
-      assert(!Result || (isSentinel(LHS) && LHS == RHS) ||
-             getHashValueImpl(LHS) == getHashValueImpl(RHS));
-      return Result;
-    }
-  };
+  static bool isEqual(const PHINode *LHS, const PHINode *RHS) {
+    // These comparisons are nontrivial, so assert that equality implies
+    // hash equality (DenseMap demands this as an invariant).
+    bool Result = isEqualImpl(LHS, RHS);
+    assert(!Result || (isSentinel(LHS) && LHS == RHS) ||
+           getHashValueImpl(LHS) == getHashValueImpl(RHS));
+    return Result;
+  }
+};
 
+static bool
+EliminateDuplicatePHINodesSetBasedImpl(BasicBlock *BB,
+                                       SmallPtrSetImpl<PHINode *> &ToRemove) {
   // Set of unique PHINodes.
   DenseSet<PHINode *, PHIDenseMapInfo> PHISet;
   PHISet.reserve(4 * PHICSENumPHISmallSize);
@@ -1524,6 +1524,111 @@ bool llvm::EliminateDuplicatePHINodes(BasicBlock *BB) {
   return Changed;
 }
 
+#ifndef NDEBUG // Should this be under EXPENSIVE_CHECKS?
+// New PHI nodes should not reference one another but they may reference
+// themselves or existing PHI nodes, and existing PHI nodes may reference new
+// PHI nodes.
+static bool
+PHIAreRefEachOther(const iterator_range<BasicBlock::phi_iterator> &NewPHIs) {
+  SmallPtrSet<PHINode *, 8> NewPHISet;
+  for (PHINode &PN : NewPHIs)
+    NewPHISet.insert(&PN);
+  for (PHINode &PHI : NewPHIs) {
+    for (Value *V : PHI.incoming_values()) {
+      PHINode *IncPHI = dyn_cast<PHINode>(V);
+      if (IncPHI && IncPHI != &PHI && NewPHISet.contains(IncPHI))
+        return true;
+    }
+  }
+  return false;
+}
+#endif
+
+bool EliminateNewDuplicatePHINodesN2(BasicBlock *BB,
+                                     BasicBlock::phi_iterator FirstExistedPN) {
+  auto ReplaceIfIdentical = [](PHINode &PHI, PHINode &ReplPHI) {
+    if (!PHI.isIdenticalToWhenDefined(&ReplPHI))
+      return false;
+    PHI.replaceAllUsesWith(&ReplPHI);
+    PHI.eraseFromParent();
+    return true;
+  };
+
+  // Deduplicate new PHIs first to reduce the number of comparisons on the
+  // following new -> existing pass.
+  bool Changed = false;
+  for (auto I = BB->phis().begin(); I != FirstExistedPN; ++I) {
+    for (auto J = std::next(I); J != FirstExistedPN;) {
+      Changed |= ReplaceIfIdentical(*J++, *I);
+    }
+  }
+
+  // Iterate over existing PHIs and replace identical new PHIs.
+  for (PHINode &ExistingPHI : make_range(FirstExistedPN, BB->phis().end())) {
+    auto I = BB->phis().begin();
+    assert(I != FirstExistedPN); // Should be at least one new PHI.
+    do {
+      Changed |= ReplaceIfIdentical(*I++, ExistingPHI);
+    } while (I != FirstExistedPN);
+    if (BB->phis().begin() == FirstExistedPN)
+      return Changed;
+  }
+  return Changed;
+}
+
+bool EliminateNewDuplicatePHINodesSet(BasicBlock *BB,
+                                      BasicBlock::phi_iterator FirstExistedPN) {
+  auto Replace = [](PHINode &PHI, PHINode &ReplPHI) {
+    PHI.replaceAllUsesWith(&ReplPHI);
+    PHI.eraseFromParent();
+    return true;
+  };
+
+  DenseSet<PHINode *, PHIDenseMapInfo> NewPHISet;
+  NewPHISet.reserve(4 * PHICSENumPHISmallSize);
+
+  // Deduplicate new PHIs, note that NewPHISet remains consistent because new
+  // PHIs are not reference each other.
+  bool Changed = false;
+  for (PHINode &NewPHI :
+       make_early_inc_range(make_range(BB->phis().begin(), FirstExistedPN))) {
+    auto [I, Inserted] = NewPHISet.insert(&NewPHI);
+    if (!Inserted)
+      Changed |= Replace(NewPHI, **I);
+  }
+
+  // Iterate over existing PHIs and replace matching new PHIs.
+  for (PHINode &ExistingPHI : make_range(FirstExistedPN, BB->phis().end())) {
+    assert(!NewPHISet.empty()); // Should be at least one new PHI.
+    auto I = NewPHISet.find(&ExistingPHI);
+    if (I == NewPHISet.end())
+      continue;
+    Changed |= Replace(**I, ExistingPHI);
+    NewPHISet.erase(I);
+    if (NewPHISet.empty())
+      return Changed;
+  }
+  return Changed;
+}
+
+bool llvm::EliminateNewDuplicatePHINodes(
+    BasicBlock *BB, BasicBlock::phi_iterator FirstExistedPN) {
+  
+  if (hasNItemsOrLess(BB->phis(), 1))
+    return false;
+
+  auto NewPHIs = make_range(BB->phis().begin(), FirstExistedPN);
+  assert(!PHIAreRefEachOther(NewPHIs));
+
+  // Both functions perform identical pass over existing PHIs and differ in time
+  // spent on new PHI duplicate check which depends on the number of new PHIs.
+  // Therefore make a choice based on the number of new PHIs and not the total
+  // number of PHIs in the block.
+  return hasNItemsOrLess(NewPHIs, PHICSENumPHISmallSize)
+             ? EliminateNewDuplicatePHINodesN2(BB, FirstExistedPN)
+             : EliminateNewDuplicatePHINodesSet(BB, FirstExistedPN);
+}
+
 Align llvm::tryEnforceAlignment(Value *V, Align PrefAlign,
                                 const DataLayout &DL) {
   V = V->stripPointerCasts();