Make the reassociation pass more powerful so that it can handle expressions

with arbitrary topologies (previously it would give up when hitting a diamond
in the use graph for example).  The testcase from PR12764 is now reduced from
a pile of additions to the optimal 1617*%x0+208.  In doing this I changed the
previous strategy of dropping all uses for expression leaves to one of dropping
all but one use.  This works out more neatly (but required a bunch of tweaks)
and is also safer: some recently fixed bugs during recursive linearization were
because the linearization code thinks it completely owns a node if it has no uses
outside the expression it is linearizing.  But if the node was also in another
expression that had been linearized (and thus all uses of the node from that
expression dropped) then the conclusion that it is completely owned by the
expression currently being linearized is wrong.  Keeping one use from within each
linearized expression avoids this kind of mistake.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@157467 91177308-0d34-0410-b5e6-96231b3b80d8

lib/Transforms/Scalar/Reassociate.cpp

@@ -35,14 +35,14 @@
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/ValueHandle.h"
 #include "llvm/Support/raw_ostream.h"
+#include "llvm/ADT/DenseMap.h"
 #include "llvm/ADT/PostOrderIterator.h"
+#include "llvm/ADT/SmallMap.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/Statistic.h"
-#include "llvm/ADT/DenseMap.h"
 #include <algorithm>
 using namespace llvm;
 
-STATISTIC(NumLinear , "Number of insts linearized");
 STATISTIC(NumChanged, "Number of insts reassociated");
 STATISTIC(NumAnnihil, "Number of expr tree annihilated");
 STATISTIC(NumFactor , "Number of multiplies factored");
@@ -134,8 +134,7 @@ namespace {
     void BuildRankMap(Function &F);
     unsigned getRank(Value *V);
     Value *ReassociateExpression(BinaryOperator *I);
-    void RewriteExprTree(BinaryOperator *I, SmallVectorImpl<ValueEntry> &Ops,
+    void RewriteExprTree(BinaryOperator *I, SmallVectorImpl<ValueEntry> &Ops);
-                         unsigned Idx = 0);
     Value *OptimizeExpression(BinaryOperator *I,
                               SmallVectorImpl<ValueEntry> &Ops);
     Value *OptimizeAdd(Instruction *I, SmallVectorImpl<ValueEntry> &Ops);
@@ -145,7 +144,6 @@ namespace {
                                    SmallVectorImpl<Factor> &Factors);
     Value *OptimizeMul(BinaryOperator *I, SmallVectorImpl<ValueEntry> &Ops);
     void LinearizeExprTree(BinaryOperator *I, SmallVectorImpl<ValueEntry> &Ops);
-    void LinearizeExpr(BinaryOperator *I);
     Value *RemoveFactorFromExpression(Value *V, Value *Factor);
     void ReassociateInst(BasicBlock::iterator &BBI);
 
@@ -160,16 +158,31 @@ INITIALIZE_PASS(Reassociate, "reassociate",
 // Public interface to the Reassociate pass
 FunctionPass *llvm::createReassociatePass() { return new Reassociate(); }
 
-void Reassociate::RemoveDeadBinaryOp(Value *V) {
+/// isReassociableOp - Return true if V is an instruction of the specified
-  Instruction *Op = dyn_cast<Instruction>(V);
+/// opcode and if it only has one use.
-  if (!Op || !isa<BinaryOperator>(Op))
+static BinaryOperator *isReassociableOp(Value *V, unsigned Opcode) {
-    return;
+  if (V->hasOneUse() && isa<Instruction>(V) &&
+      cast<Instruction>(V)->getOpcode() == Opcode)
+    return cast<BinaryOperator>(V);
+  return 0;
+}
 
-  Value *LHS = Op->getOperand(0), *RHS = Op->getOperand(1);
+void Reassociate::RemoveDeadBinaryOp(Value *V) {
+  BinaryOperator *Op = dyn_cast<BinaryOperator>(V);
+  if (!Op)
+    return;
 
   ValueRankMap.erase(Op);
   DeadInsts.push_back(Op);
+
+  BinaryOperator *LHS = isReassociableOp(Op->getOperand(0), Op->getOpcode());
+  BinaryOperator *RHS = isReassociableOp(Op->getOperand(1), Op->getOpcode());
+  Op->setOperand(0, UndefValue::get(Op->getType()));
+  Op->setOperand(1, UndefValue::get(Op->getType()));
+
+  if (LHS)
     RemoveDeadBinaryOp(LHS);
+  if (RHS)
     RemoveDeadBinaryOp(RHS);
 }
 
@@ -244,22 +257,14 @@ unsigned Reassociate::getRank(Value *V) {
   return ValueRankMap[I] = Rank;
 }
 
-/// isReassociableOp - Return true if V is an instruction of the specified
-/// opcode and if it only has one use.
-static BinaryOperator *isReassociableOp(Value *V, unsigned Opcode) {
-  if ((V->hasOneUse() || V->use_empty()) && isa<Instruction>(V) &&
-      cast<Instruction>(V)->getOpcode() == Opcode)
-    return cast<BinaryOperator>(V);
-  return 0;
-}
-
 /// LowerNegateToMultiply - Replace 0-X with X*-1.
 ///
-static Instruction *LowerNegateToMultiply(Instruction *Neg,
+static BinaryOperator *LowerNegateToMultiply(Instruction *Neg,
                          DenseMap<AssertingVH<Value>, unsigned> &ValueRankMap) {
   Constant *Cst = Constant::getAllOnesValue(Neg->getType());
 
-  Instruction *Res = BinaryOperator::CreateMul(Neg->getOperand(1), Cst, "",Neg);
+  BinaryOperator *Res =
+    BinaryOperator::CreateMul(Neg->getOperand(1), Cst, "",Neg);
   ValueRankMap.erase(Neg);
   Res->takeName(Neg);
   Neg->replaceAllUsesWith(Res);
@@ -268,174 +273,355 @@ static Instruction *LowerNegateToMultiply(Instruction *Neg,
   return Res;
 }
 
-// Given an expression of the form '(A+B)+(D+C)', turn it into '(((A+B)+C)+D)'.
+/// LinearizeExprTree - Given an associative binary expression, return the leaf
-// Note that if D is also part of the expression tree that we recurse to
+/// nodes in Ops.  The original expression is the same as Ops[0] op ... Ops[N].
-// linearize it as well.  Besides that case, this does not recurse into A,B, or
+/// Note that a node may occur multiple times in Ops, but if so all occurrences
-// C.
+/// are consecutive in the vector.
-void Reassociate::LinearizeExpr(BinaryOperator *I) {
-  BinaryOperator *LHS = isReassociableOp(I->getOperand(0), I->getOpcode());
-  BinaryOperator *RHS = isReassociableOp(I->getOperand(1), I->getOpcode());
-  assert(LHS && RHS && "Not an expression that needs linearization?");
-
-  DEBUG({
-      dbgs() << "Linear:\n";
-      dbgs() << '\t' << *LHS << "\t\n" << *RHS << "\t\n" << *I << '\n';
-    });
-
-  // Move the RHS instruction to live immediately before I, avoiding breaking
-  // dominator properties.
-  RHS->moveBefore(I);
-
-  // Move operands around to do the linearization.
-  I->setOperand(1, RHS->getOperand(0));
-  RHS->setOperand(0, LHS);
-  I->setOperand(0, RHS);
-
-  // Conservatively clear all the optional flags, which may not hold
-  // after the reassociation.
-  I->clearSubclassOptionalData();
-  LHS->clearSubclassOptionalData();
-  RHS->clearSubclassOptionalData();
-
-  ++NumLinear;
-  MadeChange = true;
-  DEBUG(dbgs() << "Linearized: " << *I << '\n');
-
-  // If D is part of this expression tree, tail recurse.
-  if (isReassociableOp(I->getOperand(1), I->getOpcode()))
-    LinearizeExpr(I);
-}
-
-/// LinearizeExprTree - Given an associative binary expression tree, traverse
-/// all of the uses putting it into canonical form.  This forces a left-linear
-/// form of the expression (((a+b)+c)+d), and collects information about the
-/// rank of the non-tree operands.
 ///
-/// NOTE: These intentionally destroys the expression tree operands (turning
+/// A leaf node is either not a binary operation of the same kind as the root
-/// them into undef values) to reduce #uses of the values.  This means that the
+/// node 'I' (i.e. is not a binary operator at all, or is, but with a different
+/// opcode), or is the same kind of binary operator but has a use which either
+/// does not belong to the expression, or does belong to the expression but is
+/// a leaf node.  Every leaf node has at least one use that is a non-leaf node
+/// of the expression, while for non-leaf nodes (except for the root 'I') every
+/// use is a non-leaf node of the expression.
+///
+/// For example:
+///           expression graph        node names
+///
+///                     +        |        I
+///                    / \       |
+///                   +   +      |      A,  B
+///                  / \ / \     |
+///                 *   +   *    |    C,  D,  E
+///                / \ / \ / \   |
+///                   +   *      |      F,  G
+///
+/// The leaf nodes are C, E, F and G.  The Ops array will contain (maybe not in
+/// that order) C, E, F, F, G, G.
+///
+/// The expression is maximal: if some instruction is a binary operator of the
+/// same kind as 'I', and all of its uses are non-leaf nodes of the expression,
+/// then the instruction also belongs to the expression, is not a leaf node of
+/// it, and its operands also belong to the expression (but may be leaf nodes).
+///
+/// NOTE: This routine will set operands of non-leaf non-root nodes to undef in
+/// order to ensure that every non-root node in the expression has *exactly one*
+/// use by a non-leaf node of the expression.  This destruction means that the
 /// caller MUST use something like RewriteExprTree to put the values back in.
 ///
+/// In the above example either the right operand of A or the left operand of B
+/// will be replaced by undef.  If it is B's operand then this gives:
+///
+///                     +        |        I
+///                    / \       |
+///                   +   +      |      A,  B - operand of B replaced with undef
+///                  / \   \     |
+///                 *   +   *    |    C,  D,  E
+///                / \ / \ / \   |
+///                   +   *      |      F,  G
+///
+/// Note that if you visit operands recursively starting from a leaf node then
+/// you will never encounter such an undef operand unless you get back to 'I',
+/// which requires passing through a phi node.
+///
+/// Note that this routine may also mutate binary operators of the wrong type
+/// that have all uses inside the expression (i.e. only used by non-leaf nodes
+/// of the expression) if it can turn them into binary operators of the right
+/// type and thus make the expression bigger.
+
 void Reassociate::LinearizeExprTree(BinaryOperator *I,
                                     SmallVectorImpl<ValueEntry> &Ops) {
-  Value *LHS = I->getOperand(0), *RHS = I->getOperand(1);
+  DEBUG(dbgs() << "LINEARIZE: " << *I << '\n');
+
+  // Visit all operands of the expression, keeping track of their weight (the
+  // number of paths from the expression root to the operand, or if you like
+  // the number of times that operand occurs in the linearized expression).
+  // For example, if I = X + A, where X = A + B, then I, X and B have weight 1
+  // while A has weight two.
+
+  // Worklist of non-leaf nodes (their operands are in the expression too) along
+  // with their weights, representing a certain number of paths to the operator.
+  // If an operator occurs in the worklist multiple times then we found multiple
+  // ways to get to it.
+  SmallVector<std::pair<BinaryOperator*, unsigned>, 8> Worklist; // (Op, Weight)
+  Worklist.push_back(std::make_pair(I, 1));
   unsigned Opcode = I->getOpcode();
 
-  // First step, linearize the expression if it is in ((A+B)+(C+D)) form.
+  // Leaves of the expression are values that either aren't the right kind of
-  BinaryOperator *LHSBO = isReassociableOp(LHS, Opcode);
+  // operation (eg: a constant, or a multiply in an add tree), or are, but have
-  BinaryOperator *RHSBO = isReassociableOp(RHS, Opcode);
+  // some uses that are not inside the expression.  For example, in I = X + X,
+  // X = A + B, the value X has two uses (by I) that are in the expression.  If
+  // X has any other uses, for example in a return instruction, then we consider
+  // X to be a leaf, and won't analyze it further.  When we first visit a value,
+  // if it has more than one use then at first we conservatively consider it to
+  // be a leaf.  Later, as the expression is explored, we may discover some more
+  // uses of the value from inside the expression.  If all uses turn out to be
+  // from within the expression (and the value is a binary operator of the right
+  // kind) then the value is no longer considered to be a leaf, and its operands
+  // are explored.
 
-  // If this is a multiply expression tree and it contains internal negations,
+  // Leaves - Keeps track of the set of putative leaves as well as the number of
-  // transform them into multiplies by -1 so they can be reassociated.
+  // paths to each leaf seen so far.
-  if (I->getOpcode() == Instruction::Mul) {
+  typedef SmallMap<Value*, unsigned, 8> LeafMap;
-    if (!LHSBO && LHS->hasOneUse() && BinaryOperator::isNeg(LHS)) {
+  LeafMap Leaves; // Leaf -> Total weight so far.
-      LHS = LowerNegateToMultiply(cast<Instruction>(LHS), ValueRankMap);
+  SmallVector<Value*, 8> LeafOrder; // Ensure deterministic leaf output order.
-      LHSBO = isReassociableOp(LHS, Opcode);
+
-    }
+#ifndef NDEBUG
-    if (!RHSBO && RHS->hasOneUse() && BinaryOperator::isNeg(RHS)) {
+  SmallPtrSet<Value*, 8> Visited; // For sanity checking the iteration scheme.
-      RHS = LowerNegateToMultiply(cast<Instruction>(RHS), ValueRankMap);
+#endif
-      RHSBO = isReassociableOp(RHS, Opcode);
+  while (!Worklist.empty()) {
-    }
+    std::pair<BinaryOperator*, unsigned> P = Worklist.pop_back_val();
+    I = P.first; // We examine the operands of this binary operator.
+    assert(P.second >= 1 && "No paths to here, so how did we get here?!");
+
+    for (unsigned OpIdx = 0; OpIdx < 2; ++OpIdx) { // Visit operands.
+      Value *Op = I->getOperand(OpIdx);
+      unsigned Weight = P.second; // Number of paths to this operand.
+      DEBUG(dbgs() << "OPERAND: " << *Op << " (" << Weight << ")\n");
+      assert(!Op->use_empty() && "No uses, so how did we get to it?!");
+
+      // If this is a binary operation of the right kind with only one use then
+      // add its operands to the expression.
+      if (BinaryOperator *BO = isReassociableOp(Op, Opcode)) {
+        assert(Visited.insert(Op) && "Not first visit!");
+        DEBUG(dbgs() << "DIRECT ADD: " << *Op << " (" << Weight << ")\n");
+        Worklist.push_back(std::make_pair(BO, Weight));
+        continue;
       }
 
-  if (!LHSBO) {
+      // Appears to be a leaf.  Is the operand already in the set of leaves?
-    if (!RHSBO) {
+      LeafMap::iterator It = Leaves.find(Op);
-      // Neither the LHS or RHS as part of the tree, thus this is a leaf.  As
+      if (It == Leaves.end()) {
-      // such, just remember these operands and their rank.
+        // Not in the leaf map.  Must be the first time we saw this operand.
-      Ops.push_back(ValueEntry(getRank(LHS), LHS));
+        assert(Visited.insert(Op) && "Not first visit!");
-      Ops.push_back(ValueEntry(getRank(RHS), RHS));
+        if (!Op->hasOneUse()) {
-
+          // This value has uses not accounted for by the expression, so it is
-      // Clear the leaves out.
+          // not safe to modify.  Mark it as being a leaf.
-      I->setOperand(0, UndefValue::get(I->getType()));
+          DEBUG(dbgs() << "ADD USES LEAF: " << *Op << " (" << Weight << ")\n");
-      I->setOperand(1, UndefValue::get(I->getType()));
+          LeafOrder.push_back(Op);
-      return;
+          Leaves[Op] = Weight;
+          continue;
         }
+        // No uses outside the expression, try morphing it.
+      } else if (It != Leaves.end()) {
+        // Already in the leaf map.
+        assert(Visited.count(Op) && "In leaf map but not visited!");
 
-    // Turn X+(Y+Z) -> (Y+Z)+X
+        // Update the number of paths to the leaf.
-    std::swap(LHSBO, RHSBO);
+        It->second += Weight;
-    std::swap(LHS, RHS);
+
-    bool Success = !I->swapOperands();
+        // The leaf already has one use from inside the expression.  As we want
-    assert(Success && "swapOperands failed");
+        // exactly one such use, drop this new use of the leaf.
-    (void)Success;
+        assert(!Op->hasOneUse() && "Only one use, but we got here twice!");
+        I->setOperand(OpIdx, UndefValue::get(I->getType()));
         MadeChange = true;
-  } else if (RHSBO) {
+
-    // Turn (A+B)+(C+D) -> (((A+B)+C)+D).  This guarantees the RHS is not
+        // If the leaf is a binary operation of the right kind and we now see
-    // part of the expression tree.
+        // that its multiple original uses were in fact all by nodes belonging
-    LinearizeExpr(I);
+        // to the expression, then no longer consider it to be a leaf and add
-    LHS = LHSBO = cast<BinaryOperator>(I->getOperand(0));
+        // its operands to the expression.
-    RHS = I->getOperand(1);
+        if (BinaryOperator *BO = isReassociableOp(Op, Opcode)) {
-    RHSBO = 0;
+          DEBUG(dbgs() << "UNLEAF: " << *Op << " (" << It->second << ")\n");
+          Worklist.push_back(std::make_pair(BO, It->second));
+          Leaves.erase(It);
+          continue;
         }
 
-  // Okay, now we know that the LHS is a nested expression and that the RHS is
+        // If we still have uses that are not accounted for by the expression
-  // not.  Perform reassociation.
+        // then it is not safe to modify the value.
-  assert(!isReassociableOp(RHS, Opcode) && "LinearizeExpr failed!");
+        if (!Op->hasOneUse())
+          continue;
 
-  // Move LHS right before I to make sure that the tree expression dominates all
+        // No uses outside the expression, try morphing it.
-  // values.
+        Weight = It->second;
-  LHSBO->moveBefore(I);
+        Leaves.erase(It); // Since the value may be morphed below.
+      }
 
-  // Linearize the expression tree on the LHS.
+      // At this point we have a value which, first of all, is not a binary
-  LinearizeExprTree(LHSBO, Ops);
+      // expression of the right kind, and secondly, is only used inside the
+      // expression.  This means that it can safely be modified.  See if we
+      // can usefully morph it into an expression of the right kind.
+      assert((!isa<Instruction>(Op) ||
+              cast<Instruction>(Op)->getOpcode() != Opcode) &&
+             "Should have been handled above!");
+      assert(Op->hasOneUse() && "Has uses outside the expression tree!");
 
-  // Remember the RHS operand and its rank.
+      // If this is a multiply expression, turn any internal negations into
-  Ops.push_back(ValueEntry(getRank(RHS), RHS));
+      // multiplies by -1 so they can be reassociated.
+      BinaryOperator *BO = dyn_cast<BinaryOperator>(Op);
+      if (Opcode == Instruction::Mul && BO && BinaryOperator::isNeg(BO)) {
+        DEBUG(dbgs() << "MORPH LEAF: " << *Op << " (" << Weight << ") TO ");
+        BO = LowerNegateToMultiply(BO, ValueRankMap);
+        DEBUG(dbgs() << *BO << 'n');
+        Worklist.push_back(std::make_pair(BO, Weight));
+        MadeChange = true;
+        continue;
+      }
 
-  // Clear the RHS leaf out.
+      // Failed to morph into an expression of the right type.  This really is
-  I->setOperand(1, UndefValue::get(I->getType()));
+      // a leaf.
+      DEBUG(dbgs() << "ADD LEAF: " << *Op << " (" << Weight << ")\n");
+      assert(!isReassociableOp(Op, Opcode) && "Value was morphed?");
+      LeafOrder.push_back(Op);
+      Leaves[Op] = Weight;
+    }
+  }
+
+  // The leaves, repeated according to their weights, represent the linearized
+  // form of the expression.
+  for (unsigned i = 0, e = LeafOrder.size(); i != e; ++i) {
+    Value *V = LeafOrder[i];
+    LeafMap::iterator It = Leaves.find(V);
+    if (It == Leaves.end())
+      // Leaf already output, or node initially thought to be a leaf wasn't.
+      continue;
+    assert(!isReassociableOp(V, Opcode) && "Shouldn't be a leaf!");
+    unsigned Weight = It->second;
+    assert(Weight > 0 && "No paths to this value!");
+    // FIXME: Rather than repeating values Weight times, use a vector of
+    // (ValueEntry, multiplicity) pairs.
+    Ops.append(Weight, ValueEntry(getRank(V), V));
+    // Ensure the leaf is only output once.
+    Leaves.erase(It);
+  }
 }
 
 // RewriteExprTree - Now that the operands for this expression tree are
-// linearized and optimized, emit them in-order.  This function is written to be
+// linearized and optimized, emit them in-order.
-// tail recursive.
 void Reassociate::RewriteExprTree(BinaryOperator *I,
-                                  SmallVectorImpl<ValueEntry> &Ops,
+                                  SmallVectorImpl<ValueEntry> &Ops) {
-                                  unsigned i) {
+  assert(Ops.size() > 1 && "Single values should be used directly!");
-  if (i+2 == Ops.size()) {
-    if (I->getOperand(0) != Ops[i].Op ||
-        I->getOperand(1) != Ops[i+1].Op) {
-      Value *OldLHS = I->getOperand(0);
-      DEBUG(dbgs() << "RA: " << *I << '\n');
-      I->setOperand(0, Ops[i].Op);
-      I->setOperand(1, Ops[i+1].Op);
 
-      // Clear all the optional flags, which may not hold after the
+  // Since our optimizations never increase the number of operations, the new
-      // reassociation if the expression involved more than just this operation.
+  // expression can always be written by reusing the existing binary operators
-      if (Ops.size() != 2)
+  // from the original expression tree, without creating any new instructions,
-        I->clearSubclassOptionalData();
+  // though the rewritten expression may have a completely different topology.
+  // We take care to not change anything if the new expression will be the same
+  // as the original.  If more than trivial changes (like commuting operands)
+  // were made then we are obliged to clear out any optional subclass data like
+  // nsw flags.
 
-      DEBUG(dbgs() << "TO: " << *I << '\n');
+  /// NodesToRewrite - Nodes from the original expression available for writing
-      MadeChange = true;
+  /// the new expression into.
-      ++NumChanged;
+  SmallVector<BinaryOperator*, 8> NodesToRewrite;
-
+  unsigned Opcode = I->getOpcode();
-      // If we reassociated a tree to fewer operands (e.g. (1+a+2) -> (a+3)
+  NodesToRewrite.push_back(I);
-      // delete the extra, now dead, nodes.
-      RemoveDeadBinaryOp(OldLHS);
-    }
-    return;
-  }
-  assert(i+2 < Ops.size() && "Ops index out of range!");
-
-  if (I->getOperand(1) != Ops[i].Op) {
-    DEBUG(dbgs() << "RA: " << *I << '\n');
-    I->setOperand(1, Ops[i].Op);
-
-    // Conservatively clear all the optional flags, which may not hold
-    // after the reassociation.
-    I->clearSubclassOptionalData();
-
-    DEBUG(dbgs() << "TO: " << *I << '\n');
-    MadeChange = true;
-    ++NumChanged;
-  }
-
-  BinaryOperator *LHS = cast<BinaryOperator>(I->getOperand(0));
-  assert(LHS->getOpcode() == I->getOpcode() &&
-         "Improper expression tree!");
 
+  // ExpressionChanged - Whether the rewritten expression differs non-trivially
+  // from the original, requiring the clearing of all optional flags.
+  bool ExpressionChanged = false;
+  BinaryOperator *Previous;
+  BinaryOperator *Op = 0;
+  for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
+    assert(!NodesToRewrite.empty() &&
+           "Optimized expressions has more nodes than original!");
+    Previous = Op; Op = NodesToRewrite.pop_back_val();
     // Compactify the tree instructions together with each other to guarantee
     // that the expression tree is dominated by all of Ops.
-  LHS->moveBefore(I);
+    if (Previous)
-  RewriteExprTree(LHS, Ops, i+1);
+      Op->moveBefore(Previous);
+
+    // The last operation (which comes earliest in the IR) is special as both
+    // operands will come from Ops, rather than just one with the other being
+    // a subexpression.
+    if (i+2 == Ops.size()) {
+      Value *NewLHS = Ops[i].Op;
+      Value *NewRHS = Ops[i+1].Op;
+      Value *OldLHS = Op->getOperand(0);
+      Value *OldRHS = Op->getOperand(1);
+
+      if (NewLHS == OldLHS && NewRHS == OldRHS)
+        // Nothing changed, leave it alone.
+        break;
+
+      if (NewLHS == OldRHS && NewRHS == OldLHS) {
+        // The order of the operands was reversed.  Swap them.
+        DEBUG(dbgs() << "RA: " << *Op << '\n');
+        Op->swapOperands();
+        DEBUG(dbgs() << "TO: " << *Op << '\n');
+        MadeChange = true;
+        ++NumChanged;
+        break;
+      }
+
+      // The new operation differs non-trivially from the original. Overwrite
+      // the old operands with the new ones.
+      DEBUG(dbgs() << "RA: " << *Op << '\n');
+      if (NewLHS != OldLHS) {
+        if (BinaryOperator *BO = isReassociableOp(OldLHS, Opcode))
+          NodesToRewrite.push_back(BO);
+        Op->setOperand(0, NewLHS);
+      }
+      if (NewRHS != OldRHS) {
+        if (BinaryOperator *BO = isReassociableOp(OldRHS, Opcode))
+          NodesToRewrite.push_back(BO);
+        Op->setOperand(1, NewRHS);
+      }
+      DEBUG(dbgs() << "TO: " << *Op << '\n');
+
+      ExpressionChanged = true;
+      MadeChange = true;
+      ++NumChanged;
+
+      break;
+    }
+
+    // Not the last operation.  The left-hand side will be a sub-expression
+    // while the right-hand side will be the current element of Ops.
+    Value *NewRHS = Ops[i].Op;
+    if (NewRHS != Op->getOperand(1)) {
+      DEBUG(dbgs() << "RA: " << *Op << '\n');
+      if (NewRHS == Op->getOperand(0)) {
+        // The new right-hand side was already present as the left operand.  If
+        // we are lucky then swapping the operands will sort out both of them.
+        Op->swapOperands();
+      } else {
+        // Overwrite with the new right-hand side.
+        if (BinaryOperator *BO = isReassociableOp(Op->getOperand(1), Opcode))
+          NodesToRewrite.push_back(BO);
+        Op->setOperand(1, NewRHS);
+        ExpressionChanged = true;
+      }
+      DEBUG(dbgs() << "TO: " << *Op << '\n');
+      MadeChange = true;
+      ++NumChanged;
+    }
+
+    // Now deal with the left-hand side.  If this is already an operation node
+    // from the original expression then just rewrite the rest of the expression
+    // into it.
+    if (BinaryOperator *BO = isReassociableOp(Op->getOperand(0), Opcode)) {
+      NodesToRewrite.push_back(BO);
+      continue;
+    }
+
+    // Otherwise, grab a spare node from the original expression and use that as
+    // the left-hand side.
+    assert(!NodesToRewrite.empty() &&
+           "Optimized expressions has more nodes than original!");
+    DEBUG(dbgs() << "RA: " << *Op << '\n');
+    Op->setOperand(0, NodesToRewrite.back());
+    DEBUG(dbgs() << "TO: " << *Op << '\n');
+    ExpressionChanged = true;
+    MadeChange = true;
+    ++NumChanged;
+  }
+
+  // If the expression changed non-trivially then clear out all subclass data in
+  // the entire rewritten expression.
+  if (ExpressionChanged) {
+    do {
+      Op->clearSubclassOptionalData();
+      if (Op == I)
+        break;
+      Op = cast<BinaryOperator>(*Op->use_begin());
+    } while (1);
+  }
+
+  // Throw away any left over nodes from the original expression.
+  for (unsigned i = 0, e = NodesToRewrite.size(); i != e; ++i)
+    RemoveDeadBinaryOp(NodesToRewrite[i]);
 }
 
 /// NegateValue - Insert instructions before the instruction pointed to by BI,
@@ -455,8 +641,7 @@ static Value *NegateValue(Value *V, Instruction *BI) {
   // the constants.  We assume that instcombine will clean up the mess later if
   // we introduce tons of unnecessary negation instructions.
   //
-  if (Instruction *I = dyn_cast<Instruction>(V))
+  if (BinaryOperator *I = isReassociableOp(V, Instruction::Add)) {
-    if (I->getOpcode() == Instruction::Add && I->hasOneUse()) {
     // Push the negates through the add.
     I->setOperand(0, NegateValue(I->getOperand(0), BI));
     I->setOperand(1, NegateValue(I->getOperand(1), BI));
@@ -653,8 +838,7 @@ Value *Reassociate::RemoveFactorFromExpression(Value *V, Value *Factor) {
   // If this was just a single multiply, remove the multiply and return the only
   // remaining operand.
   if (Factors.size() == 1) {
-    ValueRankMap.erase(BO);
+    RemoveDeadBinaryOp(BO);
-    DeadInsts.push_back(BO);
     V = Factors[0].Op;
   } else {
     RewriteExprTree(BO, Factors);
@@ -673,31 +857,16 @@ Value *Reassociate::RemoveFactorFromExpression(Value *V, Value *Factor) {
 /// Ops is the top-level list of add operands we're trying to factor.
 static void FindSingleUseMultiplyFactors(Value *V,
                                          SmallVectorImpl<Value*> &Factors,
-                                       const SmallVectorImpl<ValueEntry> &Ops,
+                                       const SmallVectorImpl<ValueEntry> &Ops) {
-                                         bool IsRoot) {
+  BinaryOperator *BO = isReassociableOp(V, Instruction::Mul);
-  BinaryOperator *BO;
+  if (!BO) {
-  if (!(V->hasOneUse() || V->use_empty()) || // More than one use.
-      !(BO = dyn_cast<BinaryOperator>(V)) ||
-      BO->getOpcode() != Instruction::Mul) {
     Factors.push_back(V);
     return;
   }
 
-  // If this value has a single use because it is another input to the add
-  // tree we're reassociating and we dropped its use, it actually has two
-  // uses and we can't factor it.
-  if (!IsRoot) {
-    for (unsigned i = 0, e = Ops.size(); i != e; ++i)
-      if (Ops[i].Op == V) {
-        Factors.push_back(V);
-        return;
-      }
-  }
-
-
   // Otherwise, add the LHS and RHS to the list of factors.
-  FindSingleUseMultiplyFactors(BO->getOperand(1), Factors, Ops, false);
+  FindSingleUseMultiplyFactors(BO->getOperand(1), Factors, Ops);
-  FindSingleUseMultiplyFactors(BO->getOperand(0), Factors, Ops, false);
+  FindSingleUseMultiplyFactors(BO->getOperand(0), Factors, Ops);
 }
 
 /// OptimizeAndOrXor - Optimize a series of operands to an 'and', 'or', or 'xor'
@@ -835,13 +1004,13 @@ Value *Reassociate::OptimizeAdd(Instruction *I,
   unsigned MaxOcc = 0;
   Value *MaxOccVal = 0;
   for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
-    BinaryOperator *BOp = dyn_cast<BinaryOperator>(Ops[i].Op);
+    BinaryOperator *BOp = isReassociableOp(Ops[i].Op, Instruction::Mul);
-    if (BOp == 0 || BOp->getOpcode() != Instruction::Mul || !BOp->use_empty())
+    if (!BOp)
       continue;
 
     // Compute all of the factors of this added value.
     SmallVector<Value*, 8> Factors;
-    FindSingleUseMultiplyFactors(BOp, Factors, Ops, true);
+    FindSingleUseMultiplyFactors(BOp, Factors, Ops);
     assert(Factors.size() > 1 && "Bad linearize!");
 
     // Add one to FactorOccurrences for each unique factor in this op.
@@ -881,8 +1050,8 @@ Value *Reassociate::OptimizeAdd(Instruction *I,
     SmallVector<WeakVH, 4> NewMulOps;
     for (unsigned i = 0; i != Ops.size(); ++i) {
       // Only try to remove factors from expressions we're allowed to.
-      BinaryOperator *BOp = dyn_cast<BinaryOperator>(Ops[i].Op);
+      BinaryOperator *BOp = isReassociableOp(Ops[i].Op, Instruction::Mul);
-      if (BOp == 0 || BOp->getOpcode() != Instruction::Mul || !BOp->use_empty())
+      if (!BOp)
         continue;
 
       if (Value *V = RemoveFactorFromExpression(Ops[i].Op, MaxOccVal)) {
@@ -959,34 +1128,21 @@ namespace {
 /// \returns Whether any factors have a power greater than one.
 bool Reassociate::collectMultiplyFactors(SmallVectorImpl<ValueEntry> &Ops,
                                          SmallVectorImpl<Factor> &Factors) {
+  // FIXME: Have Ops be (ValueEntry, Multiplicity) pairs, simplifying this.
+  // Compute the sum of powers of simplifiable factors.
   unsigned FactorPowerSum = 0;
-  DenseMap<Value *, unsigned> FactorCounts;
+  for (unsigned Idx = 1, Size = Ops.size(); Idx < Size; ++Idx) {
-  for (unsigned LastIdx = 0, Idx = 0, Size = Ops.size(); Idx < Size; ++Idx) {
+    Value *Op = Ops[Idx-1].Op;
-    // Note that 'use_empty' uses means the only use is in the linearized tree
+
-    // represented by Ops -- we remove the values from the actual operations to
+    // Count the number of occurrences of this value.
-    // reduce their use count.
+    unsigned Count = 1;
-    if (!Ops[Idx].Op->use_empty()) {
+    for (; Idx < Size && Ops[Idx].Op == Op; ++Idx)
-      if (LastIdx == Idx)
+      ++Count;
-        ++LastIdx;
-      continue;
-    }
-    if (LastIdx == Idx || Ops[LastIdx].Op != Ops[Idx].Op) {
-      LastIdx = Idx;
-      continue;
-    }
     // Track for simplification all factors which occur 2 or more times.
-    DenseMap<Value *, unsigned>::iterator CountIt;
+    if (Count > 1)
-    bool Inserted;
+      FactorPowerSum += Count;
-    llvm::tie(CountIt, Inserted)
-      = FactorCounts.insert(std::make_pair(Ops[Idx].Op, 2));
-    if (Inserted) {
-      FactorPowerSum += 2;
-      Factors.push_back(Factor(Ops[Idx].Op, 2));
-    } else {
-      ++CountIt->second;
-      ++FactorPowerSum;
-    }
   }
+
   // We can only simplify factors if the sum of the powers of our simplifiable
   // factors is 4 or higher. When that is the case, we will *always* have
   // a simplification. This is an important invariant to prevent cyclicly
@@ -994,35 +1150,29 @@ bool Reassociate::collectMultiplyFactors(SmallVectorImpl<ValueEntry> &Ops,
   if (FactorPowerSum < 4)
     return false;
 
-  // Remove all the operands which are in the map.
+  // Now gather the simplifiable factors, removing them from Ops.
-  Ops.erase(std::remove_if(Ops.begin(), Ops.end(), IsValueInMap(FactorCounts)),
+  FactorPowerSum = 0;
-            Ops.end());
+  for (unsigned Idx = 1; Idx < Ops.size(); ++Idx) {
+    Value *Op = Ops[Idx-1].Op;
 
-  // Record the adjusted power for the simplification factors. We add back into
+    // Count the number of occurrences of this value.
-  // the Ops list any values with an odd power, and make the power even. This
+    unsigned Count = 1;
-  // allows the outer-most multiplication tree to remain in tact during
+    for (; Idx < Ops.size() && Ops[Idx].Op == Op; ++Idx)
-  // simplification.
+      ++Count;
-  unsigned OldOpsSize = Ops.size();
+    if (Count == 1)
-  for (unsigned Idx = 0, Size = Factors.size(); Idx != Size; ++Idx) {
+      continue;
-    Factors[Idx].Power = FactorCounts[Factors[Idx].Base];
+    // Move an even number of occurences to Factors.
-    if (Factors[Idx].Power & 1) {
+    Count &= ~1U;
-      Ops.push_back(ValueEntry(getRank(Factors[Idx].Base), Factors[Idx].Base));
+    Idx -= Count;
-      --Factors[Idx].Power;
+    FactorPowerSum += Count;
-      --FactorPowerSum;
+    Factors.push_back(Factor(Op, Count));
-    }
+    Ops.erase(Ops.begin()+Idx, Ops.begin()+Idx+Count);
   }
+
   // None of the adjustments above should have reduced the sum of factor powers
   // below our mininum of '4'.
   assert(FactorPowerSum >= 4);
 
-  // Patch up the sort of the ops vector by sorting the factors we added back
-  // onto the back, and merging the two sequences.
-  if (OldOpsSize != Ops.size()) {
-    SmallVectorImpl<ValueEntry>::iterator MiddleIt = Ops.begin() + OldOpsSize;
-    std::sort(MiddleIt, Ops.end());
-    std::inplace_merge(Ops.begin(), MiddleIt, Ops.end());
-  }
-
   std::sort(Factors.begin(), Factors.end(), Factor::PowerDescendingSorter());
   return true;
 }
@@ -1098,7 +1248,6 @@ Value *Reassociate::buildMinimalMultiplyDAG(IRBuilder<> &Builder,
     return OuterProduct.front();
 
   Value *V = buildMultiplyTree(Builder, OuterProduct);
-  RedoInsts.push_back(V);
   return V;
 }
 
@@ -1297,8 +1446,6 @@ Value *Reassociate::ReassociateExpression(BinaryOperator *I) {
   SmallVector<ValueEntry, 8> Ops;
   LinearizeExprTree(I, Ops);
 
-  DEBUG(dbgs() << "RAIn:\t"; PrintOps(I, Ops); dbgs() << '\n');
-
   // Now that we have linearized the tree to a list and have gathered all of
   // the operands and their ranks, sort the operands by their rank.  Use a
   // stable_sort so that values with equal ranks will have their relative
@@ -1307,6 +1454,8 @@ Value *Reassociate::ReassociateExpression(BinaryOperator *I) {
   // the vector.
   std::stable_sort(Ops.begin(), Ops.end());
 
+  DEBUG(dbgs() << "RAIn:\t"; PrintOps(I, Ops); dbgs() << '\n');
+
   // OptimizeExpression - Now that we have the expression tree in a convenient
   // sorted form, optimize it globally if possible.
   if (Value *V = OptimizeExpression(I, Ops)) {
@@ -1368,13 +1517,14 @@ bool Reassociate::runOnFunction(Function &F) {
       ReassociateInst(BBI);
     }
 
+  // We are done with the rank map.
+  RankMap.clear();
+  ValueRankMap.clear();
+
   // Now that we're done, delete any instructions which are no longer used.
   while (!DeadInsts.empty())
     if (Value *V = DeadInsts.pop_back_val())
       RecursivelyDeleteTriviallyDeadInstructions(V);
 
-  // We are done with the rank map.
-  RankMap.clear();
-  ValueRankMap.clear();
   return MadeChange;
 }

test/Transforms/Reassociate/2012-05-08-UndefLeak.ll

@@ -1,8 +1,12 @@
 ; RUN: opt < %s -reassociate -S | FileCheck %s
 ; PR12169
+; PR12764
 
 define i64 @f(i64 %x0) {
-; CHECK-NOT: undef
+; CHECK: @f
+; CHECK-NEXT: mul i64 %x0, 208
+; CHECK-NEXT: add i64 %{{.*}}, 1617
+; CHECK-NEXT: ret i64
   %t0 = add i64 %x0, 1
   %t1 = add i64 %x0, 2
   %t2 = add i64 %x0, 3