lib/Transforms/Scalar/Reassociate.cpp

   1 //===- Reassociate.cpp - Reassociate binary expressions -------------------===//
   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 reassociates commutative expressions in an order that is designed
  11 // to promote better constant propagation, GCSE, LICM, PRE, etc.
  12 //
  13 // For example: 4 + (x + 5) -> x + (4 + 5)
  14 //
  15 // In the implementation of this algorithm, constants are assigned rank = 0,
  16 // function arguments are rank = 1, and other values are assigned ranks
  17 // corresponding to the reverse post order traversal of current function
  18 // (starting at 2), which effectively gives values in deep loops higher rank
  19 // than values not in loops.
  20 //
  21 //===----------------------------------------------------------------------===//
  22
  23 #define DEBUG_TYPE "reassociate"
  24 #include "llvm/Transforms/Scalar.h"
  25 #include "llvm/Constants.h"
  26 #include "llvm/DerivedTypes.h"
  27 #include "llvm/Function.h"
  28 #include "llvm/Instructions.h"
  29 #include "llvm/IntrinsicInst.h"
  30 #include "llvm/Pass.h"
  31 #include "llvm/Assembly/Writer.h"
  32 #include "llvm/Support/CFG.h"
  33 #include "llvm/Support/Debug.h"
  34 #include "llvm/Support/ValueHandle.h"
  35 #include "llvm/Support/raw_ostream.h"
  36 #include "llvm/ADT/PostOrderIterator.h"
  37 #include "llvm/ADT/Statistic.h"
  38 #include "llvm/ADT/DenseMap.h"
  39 #include <algorithm>
  40 using namespace llvm;
  41
  42 STATISTIC(NumLinear , "Number of insts linearized");
  43 STATISTIC(NumChanged, "Number of insts reassociated");
  44 STATISTIC(NumAnnihil, "Number of expr tree annihilated");
  45 STATISTIC(NumFactor , "Number of multiplies factored");
  46
  47 namespace {
  48   struct ValueEntry {
  49     unsigned Rank;
  50     Value *Op;
  51     ValueEntry(unsigned R, Value *O) : Rank(R), Op(O) {}
  52   };
  53   inline bool operator<(const ValueEntry &LHS, const ValueEntry &RHS) {
  54     return LHS.Rank > RHS.Rank;   // Sort so that highest rank goes to start.
  55   }
  56 }
  57
  58 #ifndef NDEBUG
  59 /// PrintOps - Print out the expression identified in the Ops list.
  60 ///
  61 static void PrintOps(Instruction *I, const SmallVectorImpl<ValueEntry> &Ops) {
  62   Module *M = I->getParent()->getParent()->getParent();
  63   dbgs() << Instruction::getOpcodeName(I->getOpcode()) << " "
  64        << *Ops[0].Op->getType() << '\t';
  65   for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
  66     dbgs() << "[ ";
  67     WriteAsOperand(dbgs(), Ops[i].Op, false, M);
  68     dbgs() << ", #" << Ops[i].Rank << "] ";
  69   }
  70 }
  71 #endif
  72
  73 namespace {
  74   class Reassociate : public FunctionPass {
  75     DenseMap<BasicBlock*, unsigned> RankMap;
  76     DenseMap<AssertingVH<>, unsigned> ValueRankMap;
  77     bool MadeChange;
  78   public:
  79     static char ID; // Pass identification, replacement for typeid
  80     Reassociate() : FunctionPass(ID) {
  81       initializeReassociatePass(*PassRegistry::getPassRegistry());
  82     }
  83
  84     bool runOnFunction(Function &F);
  85
  86     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  87       AU.setPreservesCFG();
  88     }
  89   private:
  90     void BuildRankMap(Function &F);
  91     unsigned getRank(Value *V);
  92     Value *ReassociateExpression(BinaryOperator *I);
  93     void RewriteExprTree(BinaryOperator *I, SmallVectorImpl<ValueEntry> &Ops,
  94                          unsigned Idx = 0);
  95     Value *OptimizeExpression(BinaryOperator *I,
  96                               SmallVectorImpl<ValueEntry> &Ops);
  97     Value *OptimizeAdd(Instruction *I, SmallVectorImpl<ValueEntry> &Ops);
  98     void LinearizeExprTree(BinaryOperator *I, SmallVectorImpl<ValueEntry> &Ops);
  99     void LinearizeExpr(BinaryOperator *I);
 100     Value *RemoveFactorFromExpression(Value *V, Value *Factor);
 101     void ReassociateBB(BasicBlock *BB);
 102
 103     void RemoveDeadBinaryOp(Value *V);
 104   };
 105 }
 106
 107 char Reassociate::ID = 0;
 108 INITIALIZE_PASS(Reassociate, "reassociate",
 109                 "Reassociate expressions", false, false)
 110
 111 // Public interface to the Reassociate pass
 112 FunctionPass *llvm::createReassociatePass() { return new Reassociate(); }
 113
 114 void Reassociate::RemoveDeadBinaryOp(Value *V) {
 115   Instruction *Op = dyn_cast<Instruction>(V);
 116   if (!Op || !isa<BinaryOperator>(Op) || !Op->use_empty())
 117     return;
 118
 119   Value *LHS = Op->getOperand(0), *RHS = Op->getOperand(1);
 120
 121   ValueRankMap.erase(Op);
 122   Op->eraseFromParent();
 123   RemoveDeadBinaryOp(LHS);
 124   RemoveDeadBinaryOp(RHS);
 125 }
 126
 127
 128 static bool isUnmovableInstruction(Instruction *I) {
 129   if (I->getOpcode() == Instruction::PHI ||
 130       I->getOpcode() == Instruction::Alloca ||
 131       I->getOpcode() == Instruction::Load ||
 132       I->getOpcode() == Instruction::Invoke ||
 133       (I->getOpcode() == Instruction::Call &&
 134        !isa<DbgInfoIntrinsic>(I)) ||
 135       I->getOpcode() == Instruction::UDiv ||
 136       I->getOpcode() == Instruction::SDiv ||
 137       I->getOpcode() == Instruction::FDiv ||
 138       I->getOpcode() == Instruction::URem ||
 139       I->getOpcode() == Instruction::SRem ||
 140       I->getOpcode() == Instruction::FRem)
 141     return true;
 142   return false;
 143 }
 144
 145 void Reassociate::BuildRankMap(Function &F) {
 146   unsigned i = 2;
 147
 148   // Assign distinct ranks to function arguments
 149   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I)
 150     ValueRankMap[&*I] = ++i;
 151
 152   ReversePostOrderTraversal<Function*> RPOT(&F);
 153   for (ReversePostOrderTraversal<Function*>::rpo_iterator I = RPOT.begin(),
 154          E = RPOT.end(); I != E; ++I) {
 155     BasicBlock *BB = *I;
 156     unsigned BBRank = RankMap[BB] = ++i << 16;
 157
 158     // Walk the basic block, adding precomputed ranks for any instructions that
 159     // we cannot move.  This ensures that the ranks for these instructions are
 160     // all different in the block.
 161     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 162       if (isUnmovableInstruction(I))
 163         ValueRankMap[&*I] = ++BBRank;
 164   }
 165 }
 166
 167 unsigned Reassociate::getRank(Value *V) {
 168   Instruction *I = dyn_cast<Instruction>(V);
 169   if (I == 0) {
 170     if (isa<Argument>(V)) return ValueRankMap[V];   // Function argument.
 171     return 0;  // Otherwise it's a global or constant, rank 0.
 172   }
 173
 174   if (unsigned Rank = ValueRankMap[I])
 175     return Rank;    // Rank already known?
 176
 177   // If this is an expression, return the 1+MAX(rank(LHS), rank(RHS)) so that
 178   // we can reassociate expressions for code motion!  Since we do not recurse
 179   // for PHI nodes, we cannot have infinite recursion here, because there
 180   // cannot be loops in the value graph that do not go through PHI nodes.
 181   unsigned Rank = 0, MaxRank = RankMap[I->getParent()];
 182   for (unsigned i = 0, e = I->getNumOperands();
 183        i != e && Rank != MaxRank; ++i)
 184     Rank = std::max(Rank, getRank(I->getOperand(i)));
 185
 186   // If this is a not or neg instruction, do not count it for rank.  This
 187   // assures us that X and ~X will have the same rank.
 188   if (!I->getType()->isIntegerTy() ||
 189       (!BinaryOperator::isNot(I) && !BinaryOperator::isNeg(I)))
 190     ++Rank;
 191
 192   //DEBUG(dbgs() << "Calculated Rank[" << V->getName() << "] = "
 193   //     << Rank << "\n");
 194
 195   return ValueRankMap[I] = Rank;
 196 }
 197
 198 /// isReassociableOp - Return true if V is an instruction of the specified
 199 /// opcode and if it only has one use.
 200 static BinaryOperator *isReassociableOp(Value *V, unsigned Opcode) {
 201   if ((V->hasOneUse() || V->use_empty()) && isa<Instruction>(V) &&
 202       cast<Instruction>(V)->getOpcode() == Opcode)
 203     return cast<BinaryOperator>(V);
 204   return 0;
 205 }
 206
 207 /// LowerNegateToMultiply - Replace 0-X with X*-1.
 208 ///
 209 static Instruction *LowerNegateToMultiply(Instruction *Neg,
 210                               DenseMap<AssertingVH<>, unsigned> &ValueRankMap) {
 211   Constant *Cst = Constant::getAllOnesValue(Neg->getType());
 212
 213   Instruction *Res = BinaryOperator::CreateMul(Neg->getOperand(1), Cst, "",Neg);
 214   ValueRankMap.erase(Neg);
 215   Res->takeName(Neg);
 216   Neg->replaceAllUsesWith(Res);
 217   Neg->eraseFromParent();
 218   return Res;
 219 }
 220
 221 // Given an expression of the form '(A+B)+(D+C)', turn it into '(((A+B)+C)+D)'.
 222 // Note that if D is also part of the expression tree that we recurse to
 223 // linearize it as well.  Besides that case, this does not recurse into A,B, or
 224 // C.
 225 void Reassociate::LinearizeExpr(BinaryOperator *I) {
 226   BinaryOperator *LHS = cast<BinaryOperator>(I->getOperand(0));
 227   BinaryOperator *RHS = cast<BinaryOperator>(I->getOperand(1));
 228   assert(isReassociableOp(LHS, I->getOpcode()) &&
 229          isReassociableOp(RHS, I->getOpcode()) &&
 230          "Not an expression that needs linearization?");
 231
 232   DEBUG(dbgs() << "Linear" << *LHS << '\n' << *RHS << '\n' << *I << '\n');
 233
 234   // Move the RHS instruction to live immediately before I, avoiding breaking
 235   // dominator properties.
 236   RHS->moveBefore(I);
 237
 238   // Move operands around to do the linearization.
 239   I->setOperand(1, RHS->getOperand(0));
 240   RHS->setOperand(0, LHS);
 241   I->setOperand(0, RHS);
 242
 243   // Conservatively clear all the optional flags, which may not hold
 244   // after the reassociation.
 245   I->clearSubclassOptionalData();
 246   LHS->clearSubclassOptionalData();
 247   RHS->clearSubclassOptionalData();
 248
 249   ++NumLinear;
 250   MadeChange = true;
 251   DEBUG(dbgs() << "Linearized: " << *I << '\n');
 252
 253   // If D is part of this expression tree, tail recurse.
 254   if (isReassociableOp(I->getOperand(1), I->getOpcode()))
 255     LinearizeExpr(I);
 256 }
 257
 258
 259 /// LinearizeExprTree - Given an associative binary expression tree, traverse
 260 /// all of the uses putting it into canonical form.  This forces a left-linear
 261 /// form of the expression (((a+b)+c)+d), and collects information about the
 262 /// rank of the non-tree operands.
 263 ///
 264 /// NOTE: These intentionally destroys the expression tree operands (turning
 265 /// them into undef values) to reduce #uses of the values.  This means that the
 266 /// caller MUST use something like RewriteExprTree to put the values back in.
 267 ///
 268 void Reassociate::LinearizeExprTree(BinaryOperator *I,
 269                                     SmallVectorImpl<ValueEntry> &Ops) {
 270   Value *LHS = I->getOperand(0), *RHS = I->getOperand(1);
 271   unsigned Opcode = I->getOpcode();
 272
 273   // First step, linearize the expression if it is in ((A+B)+(C+D)) form.
 274   BinaryOperator *LHSBO = isReassociableOp(LHS, Opcode);
 275   BinaryOperator *RHSBO = isReassociableOp(RHS, Opcode);
 276
 277   // If this is a multiply expression tree and it contains internal negations,
 278   // transform them into multiplies by -1 so they can be reassociated.
 279   if (I->getOpcode() == Instruction::Mul) {
 280     if (!LHSBO && LHS->hasOneUse() && BinaryOperator::isNeg(LHS)) {
 281       LHS = LowerNegateToMultiply(cast<Instruction>(LHS), ValueRankMap);
 282       LHSBO = isReassociableOp(LHS, Opcode);
 283     }
 284     if (!RHSBO && RHS->hasOneUse() && BinaryOperator::isNeg(RHS)) {
 285       RHS = LowerNegateToMultiply(cast<Instruction>(RHS), ValueRankMap);
 286       RHSBO = isReassociableOp(RHS, Opcode);
 287     }
 288   }
 289
 290   if (!LHSBO) {
 291     if (!RHSBO) {
 292       // Neither the LHS or RHS as part of the tree, thus this is a leaf.  As
 293       // such, just remember these operands and their rank.
 294       Ops.push_back(ValueEntry(getRank(LHS), LHS));
 295       Ops.push_back(ValueEntry(getRank(RHS), RHS));
 296
 297       // Clear the leaves out.
 298       I->setOperand(0, UndefValue::get(I->getType()));
 299       I->setOperand(1, UndefValue::get(I->getType()));
 300       return;
 301     }
 302
 303     // Turn X+(Y+Z) -> (Y+Z)+X
 304     std::swap(LHSBO, RHSBO);
 305     std::swap(LHS, RHS);
 306     bool Success = !I->swapOperands();
 307     assert(Success && "swapOperands failed");
 308     Success = false;
 309     MadeChange = true;
 310   } else if (RHSBO) {
 311     // Turn (A+B)+(C+D) -> (((A+B)+C)+D).  This guarantees the RHS is not
 312     // part of the expression tree.
 313     LinearizeExpr(I);
 314     LHS = LHSBO = cast<BinaryOperator>(I->getOperand(0));
 315     RHS = I->getOperand(1);
 316     RHSBO = 0;
 317   }
 318
 319   // Okay, now we know that the LHS is a nested expression and that the RHS is
 320   // not.  Perform reassociation.
 321   assert(!isReassociableOp(RHS, Opcode) && "LinearizeExpr failed!");
 322
 323   // Move LHS right before I to make sure that the tree expression dominates all
 324   // values.
 325   LHSBO->moveBefore(I);
 326
 327   // Linearize the expression tree on the LHS.
 328   LinearizeExprTree(LHSBO, Ops);
 329
 330   // Remember the RHS operand and its rank.
 331   Ops.push_back(ValueEntry(getRank(RHS), RHS));
 332
 333   // Clear the RHS leaf out.
 334   I->setOperand(1, UndefValue::get(I->getType()));
 335 }
 336
 337 // RewriteExprTree - Now that the operands for this expression tree are
 338 // linearized and optimized, emit them in-order.  This function is written to be
 339 // tail recursive.
 340 void Reassociate::RewriteExprTree(BinaryOperator *I,
 341                                   SmallVectorImpl<ValueEntry> &Ops,
 342                                   unsigned i) {
 343   if (i+2 == Ops.size()) {
 344     if (I->getOperand(0) != Ops[i].Op ||
 345         I->getOperand(1) != Ops[i+1].Op) {
 346       Value *OldLHS = I->getOperand(0);
 347       DEBUG(dbgs() << "RA: " << *I << '\n');
 348       I->setOperand(0, Ops[i].Op);
 349       I->setOperand(1, Ops[i+1].Op);
 350
 351       // Conservatively clear all the optional flags, which may not hold
 352       // after the reassociation.
 353       I->clearSubclassOptionalData();
 354
 355       DEBUG(dbgs() << "TO: " << *I << '\n');
 356       MadeChange = true;
 357       ++NumChanged;
 358
 359       // If we reassociated a tree to fewer operands (e.g. (1+a+2) -> (a+3)
 360       // delete the extra, now dead, nodes.
 361       RemoveDeadBinaryOp(OldLHS);
 362     }
 363     return;
 364   }
 365   assert(i+2 < Ops.size() && "Ops index out of range!");
 366
 367   if (I->getOperand(1) != Ops[i].Op) {
 368     DEBUG(dbgs() << "RA: " << *I << '\n');
 369     I->setOperand(1, Ops[i].Op);
 370
 371     // Conservatively clear all the optional flags, which may not hold
 372     // after the reassociation.
 373     I->clearSubclassOptionalData();
 374
 375     DEBUG(dbgs() << "TO: " << *I << '\n');
 376     MadeChange = true;
 377     ++NumChanged;
 378   }
 379
 380   BinaryOperator *LHS = cast<BinaryOperator>(I->getOperand(0));
 381   assert(LHS->getOpcode() == I->getOpcode() &&
 382          "Improper expression tree!");
 383
 384   // Compactify the tree instructions together with each other to guarantee
 385   // that the expression tree is dominated by all of Ops.
 386   LHS->moveBefore(I);
 387   RewriteExprTree(LHS, Ops, i+1);
 388 }
 389
 390
 391
 392 // NegateValue - Insert instructions before the instruction pointed to by BI,
 393 // that computes the negative version of the value specified.  The negative
 394 // version of the value is returned, and BI is left pointing at the instruction
 395 // that should be processed next by the reassociation pass.
 396 //
 397 static Value *NegateValue(Value *V, Instruction *BI) {
 398   if (Constant *C = dyn_cast<Constant>(V))
 399     return ConstantExpr::getNeg(C);
 400
 401   // We are trying to expose opportunity for reassociation.  One of the things
 402   // that we want to do to achieve this is to push a negation as deep into an
 403   // expression chain as possible, to expose the add instructions.  In practice,
 404   // this means that we turn this:
 405   //   X = -(A+12+C+D)   into    X = -A + -12 + -C + -D = -12 + -A + -C + -D
 406   // so that later, a: Y = 12+X could get reassociated with the -12 to eliminate
 407   // the constants.  We assume that instcombine will clean up the mess later if
 408   // we introduce tons of unnecessary negation instructions.
 409   //
 410   if (Instruction *I = dyn_cast<Instruction>(V))
 411     if (I->getOpcode() == Instruction::Add && I->hasOneUse()) {
 412       // Push the negates through the add.
 413       I->setOperand(0, NegateValue(I->getOperand(0), BI));
 414       I->setOperand(1, NegateValue(I->getOperand(1), BI));
 415
 416       // We must move the add instruction here, because the neg instructions do
 417       // not dominate the old add instruction in general.  By moving it, we are
 418       // assured that the neg instructions we just inserted dominate the
 419       // instruction we are about to insert after them.
 420       //
 421       I->moveBefore(BI);
 422       I->setName(I->getName()+".neg");
 423       return I;
 424     }
 425
 426   // Okay, we need to materialize a negated version of V with an instruction.
 427   // Scan the use lists of V to see if we have one already.
 428   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
 429     User *U = *UI;
 430     if (!BinaryOperator::isNeg(U)) continue;
 431
 432     // We found one!  Now we have to make sure that the definition dominates
 433     // this use.  We do this by moving it to the entry block (if it is a
 434     // non-instruction value) or right after the definition.  These negates will
 435     // be zapped by reassociate later, so we don't need much finesse here.
 436     BinaryOperator *TheNeg = cast<BinaryOperator>(U);
 437
 438     // Verify that the negate is in this function, V might be a constant expr.
 439     if (TheNeg->getParent()->getParent() != BI->getParent()->getParent())
 440       continue;
 441
 442     BasicBlock::iterator InsertPt;
 443     if (Instruction *InstInput = dyn_cast<Instruction>(V)) {
 444       if (InvokeInst *II = dyn_cast<InvokeInst>(InstInput)) {
 445         InsertPt = II->getNormalDest()->begin();
 446       } else {
 447         InsertPt = InstInput;
 448         ++InsertPt;
 449       }
 450       while (isa<PHINode>(InsertPt)) ++InsertPt;
 451     } else {
 452       InsertPt = TheNeg->getParent()->getParent()->getEntryBlock().begin();
 453     }
 454     TheNeg->moveBefore(InsertPt);
 455     return TheNeg;
 456   }
 457
 458   // Insert a 'neg' instruction that subtracts the value from zero to get the
 459   // negation.
 460   return BinaryOperator::CreateNeg(V, V->getName() + ".neg", BI);
 461 }
 462
 463 /// ShouldBreakUpSubtract - Return true if we should break up this subtract of
 464 /// X-Y into (X + -Y).
 465 static bool ShouldBreakUpSubtract(Instruction *Sub) {
 466   // If this is a negation, we can't split it up!
 467   if (BinaryOperator::isNeg(Sub))
 468     return false;
 469
 470   // Don't bother to break this up unless either the LHS is an associable add or
 471   // subtract or if this is only used by one.
 472   if (isReassociableOp(Sub->getOperand(0), Instruction::Add) ||
 473       isReassociableOp(Sub->getOperand(0), Instruction::Sub))
 474     return true;
 475   if (isReassociableOp(Sub->getOperand(1), Instruction::Add) ||
 476       isReassociableOp(Sub->getOperand(1), Instruction::Sub))
 477     return true;
 478   if (Sub->hasOneUse() &&
 479       (isReassociableOp(Sub->use_back(), Instruction::Add) ||
 480        isReassociableOp(Sub->use_back(), Instruction::Sub)))
 481     return true;
 482
 483   return false;
 484 }
 485
 486 /// BreakUpSubtract - If we have (X-Y), and if either X is an add, or if this is
 487 /// only used by an add, transform this into (X+(0-Y)) to promote better
 488 /// reassociation.
 489 static Instruction *BreakUpSubtract(Instruction *Sub,
 490                               DenseMap<AssertingVH<>, unsigned> &ValueRankMap) {
 491   // Convert a subtract into an add and a neg instruction. This allows sub
 492   // instructions to be commuted with other add instructions.
 493   //
 494   // Calculate the negative value of Operand 1 of the sub instruction,
 495   // and set it as the RHS of the add instruction we just made.
 496   //
 497   Value *NegVal = NegateValue(Sub->getOperand(1), Sub);
 498   Instruction *New =
 499     BinaryOperator::CreateAdd(Sub->getOperand(0), NegVal, "", Sub);
 500   New->takeName(Sub);
 501
 502   // Everyone now refers to the add instruction.
 503   ValueRankMap.erase(Sub);
 504   Sub->replaceAllUsesWith(New);
 505   Sub->eraseFromParent();
 506
 507   DEBUG(dbgs() << "Negated: " << *New << '\n');
 508   return New;
 509 }
 510
 511 /// ConvertShiftToMul - If this is a shift of a reassociable multiply or is used
 512 /// by one, change this into a multiply by a constant to assist with further
 513 /// reassociation.
 514 static Instruction *ConvertShiftToMul(Instruction *Shl,
 515                               DenseMap<AssertingVH<>, unsigned> &ValueRankMap) {
 516   // If an operand of this shift is a reassociable multiply, or if the shift
 517   // is used by a reassociable multiply or add, turn into a multiply.
 518   if (isReassociableOp(Shl->getOperand(0), Instruction::Mul) ||
 519       (Shl->hasOneUse() &&
 520        (isReassociableOp(Shl->use_back(), Instruction::Mul) ||
 521         isReassociableOp(Shl->use_back(), Instruction::Add)))) {
 522     Constant *MulCst = ConstantInt::get(Shl->getType(), 1);
 523     MulCst = ConstantExpr::getShl(MulCst, cast<Constant>(Shl->getOperand(1)));
 524
 525     Instruction *Mul =
 526       BinaryOperator::CreateMul(Shl->getOperand(0), MulCst, "", Shl);
 527     ValueRankMap.erase(Shl);
 528     Mul->takeName(Shl);
 529     Shl->replaceAllUsesWith(Mul);
 530     Shl->eraseFromParent();
 531     return Mul;
 532   }
 533   return 0;
 534 }
 535
 536 // Scan backwards and forwards among values with the same rank as element i to
 537 // see if X exists.  If X does not exist, return i.  This is useful when
 538 // scanning for 'x' when we see '-x' because they both get the same rank.
 539 static unsigned FindInOperandList(SmallVectorImpl<ValueEntry> &Ops, unsigned i,
 540                                   Value *X) {
 541   unsigned XRank = Ops[i].Rank;
 542   unsigned e = Ops.size();
 543   for (unsigned j = i+1; j != e && Ops[j].Rank == XRank; ++j)
 544     if (Ops[j].Op == X)
 545       return j;
 546   // Scan backwards.
 547   for (unsigned j = i-1; j != ~0U && Ops[j].Rank == XRank; --j)
 548     if (Ops[j].Op == X)
 549       return j;
 550   return i;
 551 }
 552
 553 /// EmitAddTreeOfValues - Emit a tree of add instructions, summing Ops together
 554 /// and returning the result.  Insert the tree before I.
 555 static Value *EmitAddTreeOfValues(Instruction *I, SmallVectorImpl<Value*> &Ops){
 556   if (Ops.size() == 1) return Ops.back();
 557
 558   Value *V1 = Ops.back();
 559   Ops.pop_back();
 560   Value *V2 = EmitAddTreeOfValues(I, Ops);
 561   return BinaryOperator::CreateAdd(V2, V1, "tmp", I);
 562 }
 563
 564 /// RemoveFactorFromExpression - If V is an expression tree that is a
 565 /// multiplication sequence, and if this sequence contains a multiply by Factor,
 566 /// remove Factor from the tree and return the new tree.
 567 Value *Reassociate::RemoveFactorFromExpression(Value *V, Value *Factor) {
 568   BinaryOperator *BO = isReassociableOp(V, Instruction::Mul);
 569   if (!BO) return 0;
 570
 571   SmallVector<ValueEntry, 8> Factors;
 572   LinearizeExprTree(BO, Factors);
 573
 574   bool FoundFactor = false;
 575   bool NeedsNegate = false;
 576   for (unsigned i = 0, e = Factors.size(); i != e; ++i) {
 577     if (Factors[i].Op == Factor) {
 578       FoundFactor = true;
 579       Factors.erase(Factors.begin()+i);
 580       break;
 581     }
 582
 583     // If this is a negative version of this factor, remove it.
 584     if (ConstantInt *FC1 = dyn_cast<ConstantInt>(Factor))
 585       if (ConstantInt *FC2 = dyn_cast<ConstantInt>(Factors[i].Op))
 586         if (FC1->getValue() == -FC2->getValue()) {
 587           FoundFactor = NeedsNegate = true;
 588           Factors.erase(Factors.begin()+i);
 589           break;
 590         }
 591   }
 592
 593   if (!FoundFactor) {
 594     // Make sure to restore the operands to the expression tree.
 595     RewriteExprTree(BO, Factors);
 596     return 0;
 597   }
 598
 599   BasicBlock::iterator InsertPt = BO; ++InsertPt;
 600
 601   // If this was just a single multiply, remove the multiply and return the only
 602   // remaining operand.
 603   if (Factors.size() == 1) {
 604     ValueRankMap.erase(BO);
 605     BO->eraseFromParent();
 606     V = Factors[0].Op;
 607   } else {
 608     RewriteExprTree(BO, Factors);
 609     V = BO;
 610   }
 611
 612   if (NeedsNegate)
 613     V = BinaryOperator::CreateNeg(V, "neg", InsertPt);
 614
 615   return V;
 616 }
 617
 618 /// FindSingleUseMultiplyFactors - If V is a single-use multiply, recursively
 619 /// add its operands as factors, otherwise add V to the list of factors.
 620 ///
 621 /// Ops is the top-level list of add operands we're trying to factor.
 622 static void FindSingleUseMultiplyFactors(Value *V,
 623                                          SmallVectorImpl<Value*> &Factors,
 624                                        const SmallVectorImpl<ValueEntry> &Ops,
 625                                          bool IsRoot) {
 626   BinaryOperator *BO;
 627   if (!(V->hasOneUse() || V->use_empty()) || // More than one use.
 628       !(BO = dyn_cast<BinaryOperator>(V)) ||
 629       BO->getOpcode() != Instruction::Mul) {
 630     Factors.push_back(V);
 631     return;
 632   }
 633
 634   // If this value has a single use because it is another input to the add
 635   // tree we're reassociating and we dropped its use, it actually has two
 636   // uses and we can't factor it.
 637   if (!IsRoot) {
 638     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
 639       if (Ops[i].Op == V) {
 640         Factors.push_back(V);
 641         return;
 642       }
 643   }
 644
 645
 646   // Otherwise, add the LHS and RHS to the list of factors.
 647   FindSingleUseMultiplyFactors(BO->getOperand(1), Factors, Ops, false);
 648   FindSingleUseMultiplyFactors(BO->getOperand(0), Factors, Ops, false);
 649 }
 650
 651 /// OptimizeAndOrXor - Optimize a series of operands to an 'and', 'or', or 'xor'
 652 /// instruction.  This optimizes based on identities.  If it can be reduced to
 653 /// a single Value, it is returned, otherwise the Ops list is mutated as
 654 /// necessary.
 655 static Value *OptimizeAndOrXor(unsigned Opcode,
 656                                SmallVectorImpl<ValueEntry> &Ops) {
 657   // Scan the operand lists looking for X and ~X pairs, along with X,X pairs.
 658   // If we find any, we can simplify the expression. X&~X == 0, X|~X == -1.
 659   for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 660     // First, check for X and ~X in the operand list.
 661     assert(i < Ops.size());
 662     if (BinaryOperator::isNot(Ops[i].Op)) {    // Cannot occur for ^.
 663       Value *X = BinaryOperator::getNotArgument(Ops[i].Op);
 664       unsigned FoundX = FindInOperandList(Ops, i, X);
 665       if (FoundX != i) {
 666         if (Opcode == Instruction::And)   // ...&X&~X = 0
 667           return Constant::getNullValue(X->getType());
 668
 669         if (Opcode == Instruction::Or)    // ...|X|~X = -1
 670           return Constant::getAllOnesValue(X->getType());
 671       }
 672     }
 673
 674     // Next, check for duplicate pairs of values, which we assume are next to
 675     // each other, due to our sorting criteria.
 676     assert(i < Ops.size());
 677     if (i+1 != Ops.size() && Ops[i+1].Op == Ops[i].Op) {
 678       if (Opcode == Instruction::And || Opcode == Instruction::Or) {
 679         // Drop duplicate values for And and Or.
 680         Ops.erase(Ops.begin()+i);
 681         --i; --e;
 682         ++NumAnnihil;
 683         continue;
 684       }
 685
 686       // Drop pairs of values for Xor.
 687       assert(Opcode == Instruction::Xor);
 688       if (e == 2)
 689         return Constant::getNullValue(Ops[0].Op->getType());
 690
 691       // Y ^ X^X -> Y
 692       Ops.erase(Ops.begin()+i, Ops.begin()+i+2);
 693       i -= 1; e -= 2;
 694       ++NumAnnihil;
 695     }
 696   }
 697   return 0;
 698 }
 699
 700 /// OptimizeAdd - Optimize a series of operands to an 'add' instruction.  This
 701 /// optimizes based on identities.  If it can be reduced to a single Value, it
 702 /// is returned, otherwise the Ops list is mutated as necessary.
 703 Value *Reassociate::OptimizeAdd(Instruction *I,
 704                                 SmallVectorImpl<ValueEntry> &Ops) {
 705   // Scan the operand lists looking for X and -X pairs.  If we find any, we
 706   // can simplify the expression. X+-X == 0.  While we're at it, scan for any
 707   // duplicates.  We want to canonicalize Y+Y+Y+Z -> 3*Y+Z.
 708   //
 709   // TODO: We could handle "X + ~X" -> "-1" if we wanted, since "-X = ~X+1".
 710   //
 711   for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 712     Value *TheOp = Ops[i].Op;
 713     // Check to see if we've seen this operand before.  If so, we factor all
 714     // instances of the operand together.  Due to our sorting criteria, we know
 715     // that these need to be next to each other in the vector.
 716     if (i+1 != Ops.size() && Ops[i+1].Op == TheOp) {
 717       // Rescan the list, remove all instances of this operand from the expr.
 718       unsigned NumFound = 0;
 719       do {
 720         Ops.erase(Ops.begin()+i);
 721         ++NumFound;
 722       } while (i != Ops.size() && Ops[i].Op == TheOp);
 723
 724       DEBUG(errs() << "\nFACTORING [" << NumFound << "]: " << *TheOp << '\n');
 725       ++NumFactor;
 726
 727       // Insert a new multiply.
 728       Value *Mul = ConstantInt::get(cast<IntegerType>(I->getType()), NumFound);
 729       Mul = BinaryOperator::CreateMul(TheOp, Mul, "factor", I);
 730
 731       // Now that we have inserted a multiply, optimize it. This allows us to
 732       // handle cases that require multiple factoring steps, such as this:
 733       // (X*2) + (X*2) + (X*2) -> (X*2)*3 -> X*6
 734       Mul = ReassociateExpression(cast<BinaryOperator>(Mul));
 735
 736       // If every add operand was a duplicate, return the multiply.
 737       if (Ops.empty())
 738         return Mul;
 739
 740       // Otherwise, we had some input that didn't have the dupe, such as
 741       // "A + A + B" -> "A*2 + B".  Add the new multiply to the list of
 742       // things being added by this operation.
 743       Ops.insert(Ops.begin(), ValueEntry(getRank(Mul), Mul));
 744
 745       --i;
 746       e = Ops.size();
 747       continue;
 748     }
 749
 750     // Check for X and -X in the operand list.
 751     if (!BinaryOperator::isNeg(TheOp))
 752       continue;
 753
 754     Value *X = BinaryOperator::getNegArgument(TheOp);
 755     unsigned FoundX = FindInOperandList(Ops, i, X);
 756     if (FoundX == i)
 757       continue;
 758
 759     // Remove X and -X from the operand list.
 760     if (Ops.size() == 2)
 761       return Constant::getNullValue(X->getType());
 762
 763     Ops.erase(Ops.begin()+i);
 764     if (i < FoundX)
 765       --FoundX;
 766     else
 767       --i;   // Need to back up an extra one.
 768     Ops.erase(Ops.begin()+FoundX);
 769     ++NumAnnihil;
 770     --i;     // Revisit element.
 771     e -= 2;  // Removed two elements.
 772   }
 773
 774   // Scan the operand list, checking to see if there are any common factors
 775   // between operands.  Consider something like A*A+A*B*C+D.  We would like to
 776   // reassociate this to A*(A+B*C)+D, which reduces the number of multiplies.
 777   // To efficiently find this, we count the number of times a factor occurs
 778   // for any ADD operands that are MULs.
 779   DenseMap<Value*, unsigned> FactorOccurrences;
 780
 781   // Keep track of each multiply we see, to avoid triggering on (X*4)+(X*4)
 782   // where they are actually the same multiply.
 783   unsigned MaxOcc = 0;
 784   Value *MaxOccVal = 0;
 785   for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 786     BinaryOperator *BOp = dyn_cast<BinaryOperator>(Ops[i].Op);
 787     if (BOp == 0 || BOp->getOpcode() != Instruction::Mul || !BOp->use_empty())
 788       continue;
 789
 790     // Compute all of the factors of this added value.
 791     SmallVector<Value*, 8> Factors;
 792     FindSingleUseMultiplyFactors(BOp, Factors, Ops, true);
 793     assert(Factors.size() > 1 && "Bad linearize!");
 794
 795     // Add one to FactorOccurrences for each unique factor in this op.
 796     SmallPtrSet<Value*, 8> Duplicates;
 797     for (unsigned i = 0, e = Factors.size(); i != e; ++i) {
 798       Value *Factor = Factors[i];
 799       if (!Duplicates.insert(Factor)) continue;
 800
 801       unsigned Occ = ++FactorOccurrences[Factor];
 802       if (Occ > MaxOcc) { MaxOcc = Occ; MaxOccVal = Factor; }
 803
 804       // If Factor is a negative constant, add the negated value as a factor
 805       // because we can percolate the negate out.  Watch for minint, which
 806       // cannot be positivified.
 807       if (ConstantInt *CI = dyn_cast<ConstantInt>(Factor))
 808         if (CI->getValue().isNegative() && !CI->getValue().isMinSignedValue()) {
 809           Factor = ConstantInt::get(CI->getContext(), -CI->getValue());
 810           assert(!Duplicates.count(Factor) &&
 811                  "Shouldn't have two constant factors, missed a canonicalize");
 812
 813           unsigned Occ = ++FactorOccurrences[Factor];
 814           if (Occ > MaxOcc) { MaxOcc = Occ; MaxOccVal = Factor; }
 815         }
 816     }
 817   }
 818
 819   // If any factor occurred more than one time, we can pull it out.
 820   if (MaxOcc > 1) {
 821     DEBUG(errs() << "\nFACTORING [" << MaxOcc << "]: " << *MaxOccVal << '\n');
 822     ++NumFactor;
 823
 824     // Create a new instruction that uses the MaxOccVal twice.  If we don't do
 825     // this, we could otherwise run into situations where removing a factor
 826     // from an expression will drop a use of maxocc, and this can cause
 827     // RemoveFactorFromExpression on successive values to behave differently.
 828     Instruction *DummyInst = BinaryOperator::CreateAdd(MaxOccVal, MaxOccVal);
 829     SmallVector<Value*, 4> NewMulOps;
 830     for (unsigned i = 0; i != Ops.size(); ++i) {
 831       // Only try to remove factors from expressions we're allowed to.
 832       BinaryOperator *BOp = dyn_cast<BinaryOperator>(Ops[i].Op);
 833       if (BOp == 0 || BOp->getOpcode() != Instruction::Mul || !BOp->use_empty())
 834         continue;
 835
 836       if (Value *V = RemoveFactorFromExpression(Ops[i].Op, MaxOccVal)) {
 837         // The factorized operand may occur several times.  Convert them all in
 838         // one fell swoop.
 839         for (unsigned j = Ops.size(); j != i;) {
 840           --j;
 841           if (Ops[j].Op == Ops[i].Op) {
 842             NewMulOps.push_back(V);
 843             Ops.erase(Ops.begin()+j);
 844           }
 845         }
 846         --i;
 847       }
 848     }
 849
 850     // No need for extra uses anymore.
 851     delete DummyInst;
 852
 853     unsigned NumAddedValues = NewMulOps.size();
 854     Value *V = EmitAddTreeOfValues(I, NewMulOps);
 855
 856     // Now that we have inserted the add tree, optimize it. This allows us to
 857     // handle cases that require multiple factoring steps, such as this:
 858     // A*A*B + A*A*C   -->   A*(A*B+A*C)   -->   A*(A*(B+C))
 859     assert(NumAddedValues > 1 && "Each occurrence should contribute a value");
 860     (void)NumAddedValues;
 861     V = ReassociateExpression(cast<BinaryOperator>(V));
 862
 863     // Create the multiply.
 864     Value *V2 = BinaryOperator::CreateMul(V, MaxOccVal, "tmp", I);
 865
 866     // Rerun associate on the multiply in case the inner expression turned into
 867     // a multiply.  We want to make sure that we keep things in canonical form.
 868     V2 = ReassociateExpression(cast<BinaryOperator>(V2));
 869
 870     // If every add operand included the factor (e.g. "A*B + A*C"), then the
 871     // entire result expression is just the multiply "A*(B+C)".
 872     if (Ops.empty())
 873       return V2;
 874
 875     // Otherwise, we had some input that didn't have the factor, such as
 876     // "A*B + A*C + D" -> "A*(B+C) + D".  Add the new multiply to the list of
 877     // things being added by this operation.
 878     Ops.insert(Ops.begin(), ValueEntry(getRank(V2), V2));
 879   }
 880
 881   return 0;
 882 }
 883
 884 Value *Reassociate::OptimizeExpression(BinaryOperator *I,
 885                                        SmallVectorImpl<ValueEntry> &Ops) {
 886   // Now that we have the linearized expression tree, try to optimize it.
 887   // Start by folding any constants that we found.
 888   bool IterateOptimization = false;
 889   if (Ops.size() == 1) return Ops[0].Op;
 890
 891   unsigned Opcode = I->getOpcode();
 892
 893   if (Constant *V1 = dyn_cast<Constant>(Ops[Ops.size()-2].Op))
 894     if (Constant *V2 = dyn_cast<Constant>(Ops.back().Op)) {
 895       Ops.pop_back();
 896       Ops.back().Op = ConstantExpr::get(Opcode, V1, V2);
 897       return OptimizeExpression(I, Ops);
 898     }
 899
 900   // Check for destructive annihilation due to a constant being used.
 901   if (ConstantInt *CstVal = dyn_cast<ConstantInt>(Ops.back().Op))
 902     switch (Opcode) {
 903     default: break;
 904     case Instruction::And:
 905       if (CstVal->isZero())                  // X & 0 -> 0
 906         return CstVal;
 907       if (CstVal->isAllOnesValue())          // X & -1 -> X
 908         Ops.pop_back();
 909       break;
 910     case Instruction::Mul:
 911       if (CstVal->isZero()) {                // X * 0 -> 0
 912         ++NumAnnihil;
 913         return CstVal;
 914       }
 915
 916       if (cast<ConstantInt>(CstVal)->isOne())
 917         Ops.pop_back();                      // X * 1 -> X
 918       break;
 919     case Instruction::Or:
 920       if (CstVal->isAllOnesValue())          // X | -1 -> -1
 921         return CstVal;
 922       // FALLTHROUGH!
 923     case Instruction::Add:
 924     case Instruction::Xor:
 925       if (CstVal->isZero())                  // X [|^+] 0 -> X
 926         Ops.pop_back();
 927       break;
 928     }
 929   if (Ops.size() == 1) return Ops[0].Op;
 930
 931   // Handle destructive annihilation due to identities between elements in the
 932   // argument list here.
 933   switch (Opcode) {
 934   default: break;
 935   case Instruction::And:
 936   case Instruction::Or:
 937   case Instruction::Xor: {
 938     unsigned NumOps = Ops.size();
 939     if (Value *Result = OptimizeAndOrXor(Opcode, Ops))
 940       return Result;
 941     IterateOptimization |= Ops.size() != NumOps;
 942     break;
 943   }
 944
 945   case Instruction::Add: {
 946     unsigned NumOps = Ops.size();
 947     if (Value *Result = OptimizeAdd(I, Ops))
 948       return Result;
 949     IterateOptimization |= Ops.size() != NumOps;
 950   }
 951
 952     break;
 953   //case Instruction::Mul:
 954   }
 955
 956   if (IterateOptimization)
 957     return OptimizeExpression(I, Ops);
 958   return 0;
 959 }
 960
 961
 962 /// ReassociateBB - Inspect all of the instructions in this basic block,
 963 /// reassociating them as we go.
 964 void Reassociate::ReassociateBB(BasicBlock *BB) {
 965   for (BasicBlock::iterator BBI = BB->begin(); BBI != BB->end(); ) {
 966     Instruction *BI = BBI++;
 967     if (BI->getOpcode() == Instruction::Shl &&
 968         isa<ConstantInt>(BI->getOperand(1)))
 969       if (Instruction *NI = ConvertShiftToMul(BI, ValueRankMap)) {
 970         MadeChange = true;
 971         BI = NI;
 972       }
 973
 974     // Reject cases where it is pointless to do this.
 975     if (!isa<BinaryOperator>(BI) || BI->getType()->isFloatingPointTy() ||
 976         BI->getType()->isVectorTy())
 977       continue;  // Floating point ops are not associative.
 978
 979     // Do not reassociate boolean (i1) expressions.  We want to preserve the
 980     // original order of evaluation for short-circuited comparisons that
 981     // SimplifyCFG has folded to AND/OR expressions.  If the expression
 982     // is not further optimized, it is likely to be transformed back to a
 983     // short-circuited form for code gen, and the source order may have been
 984     // optimized for the most likely conditions.
 985     if (BI->getType()->isIntegerTy(1))
 986       continue;
 987
 988     // If this is a subtract instruction which is not already in negate form,
 989     // see if we can convert it to X+-Y.
 990     if (BI->getOpcode() == Instruction::Sub) {
 991       if (ShouldBreakUpSubtract(BI)) {
 992         BI = BreakUpSubtract(BI, ValueRankMap);
 993         // Reset the BBI iterator in case BreakUpSubtract changed the
 994         // instruction it points to.
 995         BBI = BI;
 996         ++BBI;
 997         MadeChange = true;
 998       } else if (BinaryOperator::isNeg(BI)) {
 999         // Otherwise, this is a negation.  See if the operand is a multiply tree
1000         // and if this is not an inner node of a multiply tree.
1001         if (isReassociableOp(BI->getOperand(1), Instruction::Mul) &&
1002             (!BI->hasOneUse() ||
1003              !isReassociableOp(BI->use_back(), Instruction::Mul))) {
1004           BI = LowerNegateToMultiply(BI, ValueRankMap);
1005           MadeChange = true;
1006         }
1007       }
1008     }
1009
1010     // If this instruction is a commutative binary operator, process it.
1011     if (!BI->isAssociative()) continue;
1012     BinaryOperator *I = cast<BinaryOperator>(BI);
1013
1014     // If this is an interior node of a reassociable tree, ignore it until we
1015     // get to the root of the tree, to avoid N^2 analysis.
1016     if (I->hasOneUse() && isReassociableOp(I->use_back(), I->getOpcode()))
1017       continue;
1018
1019     // If this is an add tree that is used by a sub instruction, ignore it
1020     // until we process the subtract.
1021     if (I->hasOneUse() && I->getOpcode() == Instruction::Add &&
1022         cast<Instruction>(I->use_back())->getOpcode() == Instruction::Sub)
1023       continue;
1024
1025     ReassociateExpression(I);
1026   }
1027 }
1028
1029 Value *Reassociate::ReassociateExpression(BinaryOperator *I) {
1030
1031   // First, walk the expression tree, linearizing the tree, collecting the
1032   // operand information.
1033   SmallVector<ValueEntry, 8> Ops;
1034   LinearizeExprTree(I, Ops);
1035
1036   DEBUG(dbgs() << "RAIn:\t"; PrintOps(I, Ops); dbgs() << '\n');
1037
1038   // Now that we have linearized the tree to a list and have gathered all of
1039   // the operands and their ranks, sort the operands by their rank.  Use a
1040   // stable_sort so that values with equal ranks will have their relative
1041   // positions maintained (and so the compiler is deterministic).  Note that
1042   // this sorts so that the highest ranking values end up at the beginning of
1043   // the vector.
1044   std::stable_sort(Ops.begin(), Ops.end());
1045
1046   // OptimizeExpression - Now that we have the expression tree in a convenient
1047   // sorted form, optimize it globally if possible.
1048   if (Value *V = OptimizeExpression(I, Ops)) {
1049     // This expression tree simplified to something that isn't a tree,
1050     // eliminate it.
1051     DEBUG(dbgs() << "Reassoc to scalar: " << *V << '\n');
1052     I->replaceAllUsesWith(V);
1053     RemoveDeadBinaryOp(I);
1054     ++NumAnnihil;
1055     return V;
1056   }
1057
1058   // We want to sink immediates as deeply as possible except in the case where
1059   // this is a multiply tree used only by an add, and the immediate is a -1.
1060   // In this case we reassociate to put the negation on the outside so that we
1061   // can fold the negation into the add: (-X)*Y + Z -> Z-X*Y
1062   if (I->getOpcode() == Instruction::Mul && I->hasOneUse() &&
1063       cast<Instruction>(I->use_back())->getOpcode() == Instruction::Add &&
1064       isa<ConstantInt>(Ops.back().Op) &&
1065       cast<ConstantInt>(Ops.back().Op)->isAllOnesValue()) {
1066     ValueEntry Tmp = Ops.pop_back_val();
1067     Ops.insert(Ops.begin(), Tmp);
1068   }
1069
1070   DEBUG(dbgs() << "RAOut:\t"; PrintOps(I, Ops); dbgs() << '\n');
1071
1072   if (Ops.size() == 1) {
1073     // This expression tree simplified to something that isn't a tree,
1074     // eliminate it.
1075     I->replaceAllUsesWith(Ops[0].Op);
1076     RemoveDeadBinaryOp(I);
1077     return Ops[0].Op;
1078   }
1079
1080   // Now that we ordered and optimized the expressions, splat them back into
1081   // the expression tree, removing any unneeded nodes.
1082   RewriteExprTree(I, Ops);
1083   return I;
1084 }
1085
1086
1087 bool Reassociate::runOnFunction(Function &F) {
1088   // Recalculate the rank map for F
1089   BuildRankMap(F);
1090
1091   MadeChange = false;
1092   for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI)
1093     ReassociateBB(FI);
1094
1095   // We are done with the rank map.
1096   RankMap.clear();
1097   ValueRankMap.clear();
1098   return MadeChange;
1099 }
1100