lib/Transforms/Scalar/Reassociate.cpp

   1 //===- Reassociate.cpp - Reassociate binary expressions -------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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...
  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/Function.h"
  27 #include "llvm/Instructions.h"
  28 #include "llvm/Pass.h"
  29 #include "llvm/Type.h"
  30 #include "llvm/Assembly/Writer.h"
  31 #include "llvm/Support/CFG.h"
  32 #include "llvm/Support/Debug.h"
  33 #include "llvm/ADT/PostOrderIterator.h"
  34 #include "llvm/ADT/Statistic.h"
  35 #include <algorithm>
  36 using namespace llvm;
  37
  38 namespace {
  39   Statistic<> NumLinear ("reassociate","Number of insts linearized");
  40   Statistic<> NumChanged("reassociate","Number of insts reassociated");
  41   Statistic<> NumSwapped("reassociate","Number of insts with operands swapped");
  42   Statistic<> NumAnnihil("reassociate","Number of expr tree annihilated");
  43
  44   struct ValueEntry {
  45     unsigned Rank;
  46     Value *Op;
  47     ValueEntry(unsigned R, Value *O) : Rank(R), Op(O) {}
  48   };
  49   inline bool operator<(const ValueEntry &LHS, const ValueEntry &RHS) {
  50     return LHS.Rank > RHS.Rank;   // Sort so that highest rank goes to start.
  51   }
  52
  53   class Reassociate : public FunctionPass {
  54     std::map<BasicBlock*, unsigned> RankMap;
  55     std::map<Value*, unsigned> ValueRankMap;
  56     bool MadeChange;
  57   public:
  58     bool runOnFunction(Function &F);
  59
  60     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  61       AU.setPreservesCFG();
  62     }
  63   private:
  64     void BuildRankMap(Function &F);
  65     unsigned getRank(Value *V);
  66     void RewriteExprTree(BinaryOperator *I, unsigned Idx,
  67                          std::vector<ValueEntry> &Ops);
  68     void OptimizeExpression(unsigned Opcode, std::vector<ValueEntry> &Ops);
  69     void LinearizeExprTree(BinaryOperator *I, std::vector<ValueEntry> &Ops);
  70     void LinearizeExpr(BinaryOperator *I);
  71     void ReassociateBB(BasicBlock *BB);
  72   };
  73
  74   RegisterOpt<Reassociate> X("reassociate", "Reassociate expressions");
  75 }
  76
  77 // Public interface to the Reassociate pass
  78 FunctionPass *llvm::createReassociatePass() { return new Reassociate(); }
  79
  80
  81 static bool isUnmovableInstruction(Instruction *I) {
  82   if (I->getOpcode() == Instruction::PHI ||
  83       I->getOpcode() == Instruction::Alloca ||
  84       I->getOpcode() == Instruction::Load ||
  85       I->getOpcode() == Instruction::Malloc ||
  86       I->getOpcode() == Instruction::Invoke ||
  87       I->getOpcode() == Instruction::Call ||
  88       I->getOpcode() == Instruction::Div ||
  89       I->getOpcode() == Instruction::Rem)
  90     return true;
  91   return false;
  92 }
  93
  94 void Reassociate::BuildRankMap(Function &F) {
  95   unsigned i = 2;
  96
  97   // Assign distinct ranks to function arguments
  98   for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I)
  99     ValueRankMap[I] = ++i;
 100
 101   ReversePostOrderTraversal<Function*> RPOT(&F);
 102   for (ReversePostOrderTraversal<Function*>::rpo_iterator I = RPOT.begin(),
 103          E = RPOT.end(); I != E; ++I) {
 104     BasicBlock *BB = *I;
 105     unsigned BBRank = RankMap[BB] = ++i << 16;
 106
 107     // Walk the basic block, adding precomputed ranks for any instructions that
 108     // we cannot move.  This ensures that the ranks for these instructions are
 109     // all different in the block.
 110     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 111       if (isUnmovableInstruction(I))
 112         ValueRankMap[I] = ++BBRank;
 113   }
 114 }
 115
 116 unsigned Reassociate::getRank(Value *V) {
 117   if (isa<Argument>(V)) return ValueRankMap[V];   // Function argument...
 118
 119   Instruction *I = dyn_cast<Instruction>(V);
 120   if (I == 0) return 0;  // Otherwise it's a global or constant, rank 0.
 121
 122   unsigned &CachedRank = ValueRankMap[I];
 123   if (CachedRank) return CachedRank;    // Rank already known?
 124
 125   // If this is an expression, return the 1+MAX(rank(LHS), rank(RHS)) so that
 126   // we can reassociate expressions for code motion!  Since we do not recurse
 127   // for PHI nodes, we cannot have infinite recursion here, because there
 128   // cannot be loops in the value graph that do not go through PHI nodes.
 129   unsigned Rank = 0, MaxRank = RankMap[I->getParent()];
 130   for (unsigned i = 0, e = I->getNumOperands();
 131        i != e && Rank != MaxRank; ++i)
 132     Rank = std::max(Rank, getRank(I->getOperand(i)));
 133
 134   // If this is a not or neg instruction, do not count it for rank.  This
 135   // assures us that X and ~X will have the same rank.
 136   if (!I->getType()->isIntegral() ||
 137       (!BinaryOperator::isNot(I) && !BinaryOperator::isNeg(I)))
 138     ++Rank;
 139
 140   //DEBUG(std::cerr << "Calculated Rank[" << V->getName() << "] = "
 141   //<< Rank << "\n");
 142
 143   return CachedRank = Rank;
 144 }
 145
 146 /// isReassociableOp - Return true if V is an instruction of the specified
 147 /// opcode and if it only has one use.
 148 static BinaryOperator *isReassociableOp(Value *V, unsigned Opcode) {
 149   if (V->hasOneUse() && isa<Instruction>(V) &&
 150       cast<Instruction>(V)->getOpcode() == Opcode)
 151     return cast<BinaryOperator>(V);
 152   return 0;
 153 }
 154
 155 /// LowerNegateToMultiply - Replace 0-X with X*-1.
 156 ///
 157 static Instruction *LowerNegateToMultiply(Instruction *Neg) {
 158   Constant *Cst;
 159   if (Neg->getType()->isFloatingPoint())
 160     Cst = ConstantFP::get(Neg->getType(), -1);
 161   else
 162     Cst = ConstantInt::getAllOnesValue(Neg->getType());
 163
 164   std::string NegName = Neg->getName(); Neg->setName("");
 165   Instruction *Res = BinaryOperator::createMul(Neg->getOperand(1), Cst, NegName,
 166                                                Neg);
 167   Neg->replaceAllUsesWith(Res);
 168   Neg->eraseFromParent();
 169   return Res;
 170 }
 171
 172 // Given an expression of the form '(A+B)+(D+C)', turn it into '(((A+B)+C)+D)'.
 173 // Note that if D is also part of the expression tree that we recurse to
 174 // linearize it as well.  Besides that case, this does not recurse into A,B, or
 175 // C.
 176 void Reassociate::LinearizeExpr(BinaryOperator *I) {
 177   BinaryOperator *LHS = cast<BinaryOperator>(I->getOperand(0));
 178   BinaryOperator *RHS = cast<BinaryOperator>(I->getOperand(1));
 179   assert(isReassociableOp(LHS, I->getOpcode()) &&
 180          isReassociableOp(RHS, I->getOpcode()) &&
 181          "Not an expression that needs linearization?");
 182
 183   DEBUG(std::cerr << "Linear" << *LHS << *RHS << *I);
 184
 185   // Move the RHS instruction to live immediately before I, avoiding breaking
 186   // dominator properties.
 187   I->getParent()->getInstList().splice(I, RHS->getParent()->getInstList(), RHS);
 188
 189   // Move operands around to do the linearization.
 190   I->setOperand(1, RHS->getOperand(0));
 191   RHS->setOperand(0, LHS);
 192   I->setOperand(0, RHS);
 193
 194   ++NumLinear;
 195   MadeChange = true;
 196   DEBUG(std::cerr << "Linearized: " << *I);
 197
 198   // If D is part of this expression tree, tail recurse.
 199   if (isReassociableOp(I->getOperand(1), I->getOpcode()))
 200     LinearizeExpr(I);
 201 }
 202
 203
 204 /// LinearizeExprTree - Given an associative binary expression tree, traverse
 205 /// all of the uses putting it into canonical form.  This forces a left-linear
 206 /// form of the the expression (((a+b)+c)+d), and collects information about the
 207 /// rank of the non-tree operands.
 208 ///
 209 /// This returns the rank of the RHS operand, which is known to be the highest
 210 /// rank value in the expression tree.
 211 ///
 212 void Reassociate::LinearizeExprTree(BinaryOperator *I,
 213                                     std::vector<ValueEntry> &Ops) {
 214   Value *LHS = I->getOperand(0), *RHS = I->getOperand(1);
 215   unsigned Opcode = I->getOpcode();
 216
 217   // First step, linearize the expression if it is in ((A+B)+(C+D)) form.
 218   BinaryOperator *LHSBO = isReassociableOp(LHS, Opcode);
 219   BinaryOperator *RHSBO = isReassociableOp(RHS, Opcode);
 220
 221   // If this is a multiply expression tree and it contains internal negations,
 222   // transform them into multiplies by -1 so they can be reassociated.
 223   if (I->getOpcode() == Instruction::Mul) {
 224     if (!LHSBO && LHS->hasOneUse() && BinaryOperator::isNeg(LHS)) {
 225       LHS = LowerNegateToMultiply(cast<Instruction>(LHS));
 226       LHSBO = isReassociableOp(LHS, Opcode);
 227     }
 228     if (!RHSBO && RHS->hasOneUse() && BinaryOperator::isNeg(RHS)) {
 229       RHS = LowerNegateToMultiply(cast<Instruction>(RHS));
 230       RHSBO = isReassociableOp(RHS, Opcode);
 231     }
 232   }
 233
 234   if (!LHSBO) {
 235     if (!RHSBO) {
 236       // Neither the LHS or RHS as part of the tree, thus this is a leaf.  As
 237       // such, just remember these operands and their rank.
 238       Ops.push_back(ValueEntry(getRank(LHS), LHS));
 239       Ops.push_back(ValueEntry(getRank(RHS), RHS));
 240       return;
 241     } else {
 242       // Turn X+(Y+Z) -> (Y+Z)+X
 243       std::swap(LHSBO, RHSBO);
 244       std::swap(LHS, RHS);
 245       bool Success = !I->swapOperands();
 246       assert(Success && "swapOperands failed");
 247       MadeChange = true;
 248     }
 249   } else if (RHSBO) {
 250     // Turn (A+B)+(C+D) -> (((A+B)+C)+D).  This guarantees the the RHS is not
 251     // part of the expression tree.
 252     LinearizeExpr(I);
 253     LHS = LHSBO = cast<BinaryOperator>(I->getOperand(0));
 254     RHS = I->getOperand(1);
 255     RHSBO = 0;
 256   }
 257
 258   // Okay, now we know that the LHS is a nested expression and that the RHS is
 259   // not.  Perform reassociation.
 260   assert(!isReassociableOp(RHS, Opcode) && "LinearizeExpr failed!");
 261
 262   // Move LHS right before I to make sure that the tree expression dominates all
 263   // values.
 264   I->getParent()->getInstList().splice(I,
 265                                       LHSBO->getParent()->getInstList(), LHSBO);
 266
 267   // Linearize the expression tree on the LHS.
 268   LinearizeExprTree(LHSBO, Ops);
 269
 270   // Remember the RHS operand and its rank.
 271   Ops.push_back(ValueEntry(getRank(RHS), RHS));
 272 }
 273
 274 // RewriteExprTree - Now that the operands for this expression tree are
 275 // linearized and optimized, emit them in-order.  This function is written to be
 276 // tail recursive.
 277 void Reassociate::RewriteExprTree(BinaryOperator *I, unsigned i,
 278                                   std::vector<ValueEntry> &Ops) {
 279   if (i+2 == Ops.size()) {
 280     if (I->getOperand(0) != Ops[i].Op ||
 281         I->getOperand(1) != Ops[i+1].Op) {
 282       DEBUG(std::cerr << "RA: " << *I);
 283       I->setOperand(0, Ops[i].Op);
 284       I->setOperand(1, Ops[i+1].Op);
 285       DEBUG(std::cerr << "TO: " << *I);
 286       MadeChange = true;
 287       ++NumChanged;
 288     }
 289     return;
 290   }
 291   assert(i+2 < Ops.size() && "Ops index out of range!");
 292
 293   if (I->getOperand(1) != Ops[i].Op) {
 294     DEBUG(std::cerr << "RA: " << *I);
 295     I->setOperand(1, Ops[i].Op);
 296     DEBUG(std::cerr << "TO: " << *I);
 297     MadeChange = true;
 298     ++NumChanged;
 299   }
 300   RewriteExprTree(cast<BinaryOperator>(I->getOperand(0)), i+1, Ops);
 301 }
 302
 303
 304
 305 // NegateValue - Insert instructions before the instruction pointed to by BI,
 306 // that computes the negative version of the value specified.  The negative
 307 // version of the value is returned, and BI is left pointing at the instruction
 308 // that should be processed next by the reassociation pass.
 309 //
 310 static Value *NegateValue(Value *V, Instruction *BI) {
 311   // We are trying to expose opportunity for reassociation.  One of the things
 312   // that we want to do to achieve this is to push a negation as deep into an
 313   // expression chain as possible, to expose the add instructions.  In practice,
 314   // this means that we turn this:
 315   //   X = -(A+12+C+D)   into    X = -A + -12 + -C + -D = -12 + -A + -C + -D
 316   // so that later, a: Y = 12+X could get reassociated with the -12 to eliminate
 317   // the constants.  We assume that instcombine will clean up the mess later if
 318   // we introduce tons of unnecessary negation instructions...
 319   //
 320   if (Instruction *I = dyn_cast<Instruction>(V))
 321     if (I->getOpcode() == Instruction::Add && I->hasOneUse()) {
 322       Value *RHS = NegateValue(I->getOperand(1), BI);
 323       Value *LHS = NegateValue(I->getOperand(0), BI);
 324
 325       // We must actually insert a new add instruction here, because the neg
 326       // instructions do not dominate the old add instruction in general.  By
 327       // adding it now, we are assured that the neg instructions we just
 328       // inserted dominate the instruction we are about to insert after them.
 329       //
 330       return BinaryOperator::create(Instruction::Add, LHS, RHS,
 331                                     I->getName()+".neg", BI);
 332     }
 333
 334   // Insert a 'neg' instruction that subtracts the value from zero to get the
 335   // negation.
 336   //
 337   return BinaryOperator::createNeg(V, V->getName() + ".neg", BI);
 338 }
 339
 340 /// BreakUpSubtract - If we have (X-Y), and if either X is an add, or if this is
 341 /// only used by an add, transform this into (X+(0-Y)) to promote better
 342 /// reassociation.
 343 static Instruction *BreakUpSubtract(Instruction *Sub) {
 344   // Don't bother to break this up unless either the LHS is an associable add or
 345   // if this is only used by one.
 346   if (!isReassociableOp(Sub->getOperand(0), Instruction::Add) &&
 347       !isReassociableOp(Sub->getOperand(1), Instruction::Add) &&
 348       !(Sub->hasOneUse() &&isReassociableOp(Sub->use_back(), Instruction::Add)))
 349     return 0;
 350
 351   // Convert a subtract into an add and a neg instruction... so that sub
 352   // instructions can be commuted with other add instructions...
 353   //
 354   // Calculate the negative value of Operand 1 of the sub instruction...
 355   // and set it as the RHS of the add instruction we just made...
 356   //
 357   std::string Name = Sub->getName();
 358   Sub->setName("");
 359   Value *NegVal = NegateValue(Sub->getOperand(1), Sub);
 360   Instruction *New =
 361     BinaryOperator::createAdd(Sub->getOperand(0), NegVal, Name, Sub);
 362
 363   // Everyone now refers to the add instruction.
 364   Sub->replaceAllUsesWith(New);
 365   Sub->eraseFromParent();
 366
 367   DEBUG(std::cerr << "Negated: " << *New);
 368   return New;
 369 }
 370
 371 /// ConvertShiftToMul - If this is a shift of a reassociable multiply or is used
 372 /// by one, change this into a multiply by a constant to assist with further
 373 /// reassociation.
 374 static Instruction *ConvertShiftToMul(Instruction *Shl) {
 375   if (!isReassociableOp(Shl->getOperand(0), Instruction::Mul) &&
 376       !(Shl->hasOneUse() && isReassociableOp(Shl->use_back(),Instruction::Mul)))
 377     return 0;
 378
 379   Constant *MulCst = ConstantInt::get(Shl->getType(), 1);
 380   MulCst = ConstantExpr::getShl(MulCst, cast<Constant>(Shl->getOperand(1)));
 381
 382   std::string Name = Shl->getName();  Shl->setName("");
 383   Instruction *Mul = BinaryOperator::createMul(Shl->getOperand(0), MulCst,
 384                                                Name, Shl);
 385   Shl->replaceAllUsesWith(Mul);
 386   Shl->eraseFromParent();
 387   return Mul;
 388 }
 389
 390 // Scan backwards and forwards among values with the same rank as element i to
 391 // see if X exists.  If X does not exist, return i.
 392 static unsigned FindInOperandList(std::vector<ValueEntry> &Ops, unsigned i,
 393                                   Value *X) {
 394   unsigned XRank = Ops[i].Rank;
 395   unsigned e = Ops.size();
 396   for (unsigned j = i+1; j != e && Ops[j].Rank == XRank; ++j)
 397     if (Ops[j].Op == X)
 398       return j;
 399   // Scan backwards
 400   for (unsigned j = i-1; j != ~0U && Ops[j].Rank == XRank; --j)
 401     if (Ops[j].Op == X)
 402       return j;
 403   return i;
 404 }
 405
 406 void Reassociate::OptimizeExpression(unsigned Opcode,
 407                                      std::vector<ValueEntry> &Ops) {
 408   // Now that we have the linearized expression tree, try to optimize it.
 409   // Start by folding any constants that we found.
 410   bool IterateOptimization = false;
 411   if (Ops.size() == 1) return;
 412
 413   if (Constant *V1 = dyn_cast<Constant>(Ops[Ops.size()-2].Op))
 414     if (Constant *V2 = dyn_cast<Constant>(Ops.back().Op)) {
 415       Ops.pop_back();
 416       Ops.back().Op = ConstantExpr::get(Opcode, V1, V2);
 417       OptimizeExpression(Opcode, Ops);
 418       return;
 419     }
 420
 421   // Check for destructive annihilation due to a constant being used.
 422   if (ConstantIntegral *CstVal = dyn_cast<ConstantIntegral>(Ops.back().Op))
 423     switch (Opcode) {
 424     default: break;
 425     case Instruction::And:
 426       if (CstVal->isNullValue()) {           // ... & 0 -> 0
 427         Ops[0].Op = CstVal;
 428         Ops.erase(Ops.begin()+1, Ops.end());
 429         ++NumAnnihil;
 430         return;
 431       } else if (CstVal->isAllOnesValue()) { // ... & -1 -> ...
 432         Ops.pop_back();
 433       }
 434       break;
 435     case Instruction::Mul:
 436       if (CstVal->isNullValue()) {           // ... * 0 -> 0
 437         Ops[0].Op = CstVal;
 438         Ops.erase(Ops.begin()+1, Ops.end());
 439         ++NumAnnihil;
 440         return;
 441       } else if (cast<ConstantInt>(CstVal)->getRawValue() == 1) {
 442         Ops.pop_back();                      // ... * 1 -> ...
 443       }
 444       break;
 445     case Instruction::Or:
 446       if (CstVal->isAllOnesValue()) {        // ... | -1 -> -1
 447         Ops[0].Op = CstVal;
 448         Ops.erase(Ops.begin()+1, Ops.end());
 449         ++NumAnnihil;
 450         return;
 451       }
 452       // FALLTHROUGH!
 453     case Instruction::Add:
 454     case Instruction::Xor:
 455       if (CstVal->isNullValue())             // ... [|^+] 0 -> ...
 456         Ops.pop_back();
 457       break;
 458     }
 459
 460   // Handle destructive annihilation do to identities between elements in the
 461   // argument list here.
 462   switch (Opcode) {
 463   default: break;
 464   case Instruction::And:
 465   case Instruction::Or:
 466   case Instruction::Xor:
 467     // Scan the operand lists looking for X and ~X pairs, along with X,X pairs.
 468     // If we find any, we can simplify the expression. X&~X == 0, X|~X == -1.
 469     for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 470       // First, check for X and ~X in the operand list.
 471       if (BinaryOperator::isNot(Ops[i].Op)) {    // Cannot occur for ^.
 472         Value *X = BinaryOperator::getNotArgument(Ops[i].Op);
 473         unsigned FoundX = FindInOperandList(Ops, i, X);
 474         if (FoundX != i) {
 475           if (Opcode == Instruction::And) {   // ...&X&~X = 0
 476             Ops[0].Op = Constant::getNullValue(X->getType());
 477             Ops.erase(Ops.begin()+1, Ops.end());
 478             ++NumAnnihil;
 479             return;
 480           } else if (Opcode == Instruction::Or) {   // ...|X|~X = -1
 481             Ops[0].Op = ConstantIntegral::getAllOnesValue(X->getType());
 482             Ops.erase(Ops.begin()+1, Ops.end());
 483             ++NumAnnihil;
 484             return;
 485           }
 486         }
 487       }
 488
 489       // Next, check for duplicate pairs of values, which we assume are next to
 490       // each other, due to our sorting criteria.
 491       if (i+1 != Ops.size() && Ops[i+1].Op == Ops[i].Op) {
 492         if (Opcode == Instruction::And || Opcode == Instruction::Or) {
 493           // Drop duplicate values.
 494           Ops.erase(Ops.begin()+i);
 495           --i; --e;
 496           IterateOptimization = true;
 497           ++NumAnnihil;
 498         } else {
 499           assert(Opcode == Instruction::Xor);
 500           // ... X^X -> ...
 501           Ops.erase(Ops.begin()+i, Ops.begin()+i+2);
 502           i -= 2; e -= 2;
 503           IterateOptimization = true;
 504           ++NumAnnihil;
 505         }
 506       }
 507     }
 508     break;
 509
 510   case Instruction::Add:
 511     // Scan the operand lists looking for X and -X pairs.  If we find any, we
 512     // can simplify the expression. X+-X == 0
 513     for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
 514       // Check for X and -X in the operand list.
 515       if (BinaryOperator::isNeg(Ops[i].Op)) {
 516         Value *X = BinaryOperator::getNegArgument(Ops[i].Op);
 517         unsigned FoundX = FindInOperandList(Ops, i, X);
 518         if (FoundX != i) {
 519           // Remove X and -X from the operand list.
 520           if (Ops.size() == 2) {
 521             Ops[0].Op = Constant::getNullValue(X->getType());
 522             Ops.erase(Ops.begin()+1);
 523             ++NumAnnihil;
 524             return;
 525           } else {
 526             Ops.erase(Ops.begin()+i);
 527             if (i < FoundX) --FoundX;
 528             Ops.erase(Ops.begin()+FoundX);
 529             IterateOptimization = true;
 530             ++NumAnnihil;
 531           }
 532         }
 533       }
 534     }
 535     break;
 536   //case Instruction::Mul:
 537   }
 538
 539   if (IterateOptimization)
 540     OptimizeExpression(Opcode, Ops);
 541 }
 542
 543 /// PrintOps - Print out the expression identified in the Ops list.
 544 ///
 545 static void PrintOps(unsigned Opcode, const std::vector<ValueEntry> &Ops,
 546                      BasicBlock *BB) {
 547   Module *M = BB->getParent()->getParent();
 548   std::cerr << Instruction::getOpcodeName(Opcode) << " "
 549             << *Ops[0].Op->getType();
 550   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
 551     WriteAsOperand(std::cerr << " ", Ops[i].Op, false, true, M)
 552       << "," << Ops[i].Rank;
 553 }
 554
 555 /// ReassociateBB - Inspect all of the instructions in this basic block,
 556 /// reassociating them as we go.
 557 void Reassociate::ReassociateBB(BasicBlock *BB) {
 558   for (BasicBlock::iterator BI = BB->begin(); BI != BB->end(); ++BI) {
 559     if (BI->getOpcode() == Instruction::Shl &&
 560         isa<ConstantInt>(BI->getOperand(1)))
 561       if (Instruction *NI = ConvertShiftToMul(BI)) {
 562         MadeChange = true;
 563         BI = NI;
 564       }
 565
 566     // Reject cases where it is pointless to do this.
 567     if (!isa<BinaryOperator>(BI) || BI->getType()->isFloatingPoint())
 568       continue;  // Floating point ops are not associative.
 569
 570     // If this is a subtract instruction which is not already in negate form,
 571     // see if we can convert it to X+-Y.
 572     if (BI->getOpcode() == Instruction::Sub) {
 573       if (!BinaryOperator::isNeg(BI)) {
 574         if (Instruction *NI = BreakUpSubtract(BI)) {
 575           MadeChange = true;
 576           BI = NI;
 577         }
 578       } else {
 579         // Otherwise, this is a negation.  See if the operand is a multiply tree
 580         // and if this is not an inner node of a multiply tree.
 581         if (isReassociableOp(BI->getOperand(1), Instruction::Mul) &&
 582             (!BI->hasOneUse() ||
 583              !isReassociableOp(BI->use_back(), Instruction::Mul))) {
 584           BI = LowerNegateToMultiply(BI);
 585           MadeChange = true;
 586         }
 587       }
 588     }
 589
 590     // If this instruction is a commutative binary operator, process it.
 591     if (!BI->isAssociative()) continue;
 592     BinaryOperator *I = cast<BinaryOperator>(BI);
 593
 594     // If this is an interior node of a reassociable tree, ignore it until we
 595     // get to the root of the tree, to avoid N^2 analysis.
 596     if (I->hasOneUse() && isReassociableOp(I->use_back(), I->getOpcode()))
 597       continue;
 598
 599     // First, walk the expression tree, linearizing the tree, collecting
 600     std::vector<ValueEntry> Ops;
 601     LinearizeExprTree(I, Ops);
 602
 603     DEBUG(std::cerr << "RAIn:\t"; PrintOps(I->getOpcode(), Ops, BB);
 604           std::cerr << "\n");
 605
 606     // Now that we have linearized the tree to a list and have gathered all of
 607     // the operands and their ranks, sort the operands by their rank.  Use a
 608     // stable_sort so that values with equal ranks will have their relative
 609     // positions maintained (and so the compiler is deterministic).  Note that
 610     // this sorts so that the highest ranking values end up at the beginning of
 611     // the vector.
 612     std::stable_sort(Ops.begin(), Ops.end());
 613
 614     // OptimizeExpression - Now that we have the expression tree in a convenient
 615     // sorted form, optimize it globally if possible.
 616     OptimizeExpression(I->getOpcode(), Ops);
 617
 618     // We want to sink immediates as deeply as possible except in the case where
 619     // this is a multiply tree used only by an add, and the immediate is a -1.
 620     // In this case we reassociate to put the negation on the outside so that we
 621     // can fold the negation into the add: (-X)*Y + Z -> Z-X*Y
 622     if (I->getOpcode() == Instruction::Mul && I->hasOneUse() &&
 623         cast<Instruction>(I->use_back())->getOpcode() == Instruction::Add &&
 624         isa<ConstantInt>(Ops.back().Op) &&
 625         cast<ConstantInt>(Ops.back().Op)->isAllOnesValue()) {
 626       Ops.insert(Ops.begin(), Ops.back());
 627       Ops.pop_back();
 628     }
 629
 630     DEBUG(std::cerr << "RAOut:\t"; PrintOps(I->getOpcode(), Ops, BB);
 631           std::cerr << "\n");
 632
 633     if (Ops.size() == 1) {
 634       // This expression tree simplified to something that isn't a tree,
 635       // eliminate it.
 636       I->replaceAllUsesWith(Ops[0].Op);
 637     } else {
 638       // Now that we ordered and optimized the expressions, splat them back into
 639       // the expression tree, removing any unneeded nodes.
 640       RewriteExprTree(I, 0, Ops);
 641     }
 642   }
 643 }
 644
 645
 646 bool Reassociate::runOnFunction(Function &F) {
 647   // Recalculate the rank map for F
 648   BuildRankMap(F);
 649
 650   MadeChange = false;
 651   for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI)
 652     ReassociateBB(FI);
 653
 654   // We are done with the rank map...
 655   RankMap.clear();
 656   ValueRankMap.clear();
 657   return MadeChange;
 658 }
 659