1 //===- Reassociate.cpp - Reassociate binary expressions -------------------===//
3 // This pass reassociates commutative expressions in an order that is designed
4 // to promote better constant propagation, GCSE, LICM, PRE...
6 // For example: 4 + (x + 5) -> x + (4 + 5)
8 // Note that this pass works best if left shifts have been promoted to explicit
9 // multiplies before this pass executes.
11 // In the implementation of this algorithm, constants are assigned rank = 0,
12 // function arguments are rank = 1, and other values are assigned ranks
13 // corresponding to the reverse post order traversal of current function
14 // (starting at 2), which effectively gives values in deep loops higher rank
15 // than values not in loops.
17 // This code was originally written by Chris Lattner, and was then cleaned up
18 // and perfected by Casey Carter.
20 //===----------------------------------------------------------------------===//
22 #include "llvm/Transforms/Scalar.h"
23 #include "llvm/Function.h"
24 #include "llvm/iOperators.h"
25 #include "llvm/Type.h"
26 #include "llvm/Pass.h"
27 #include "llvm/Constant.h"
28 #include "llvm/Support/CFG.h"
29 #include "Support/Debug.h"
30 #include "Support/PostOrderIterator.h"
31 #include "Support/Statistic.h"
34 Statistic<> NumLinear ("reassociate","Number of insts linearized");
35 Statistic<> NumChanged("reassociate","Number of insts reassociated");
36 Statistic<> NumSwapped("reassociate","Number of insts with operands swapped");
38 class Reassociate : public FunctionPass {
39 std::map<BasicBlock*, unsigned> RankMap;
40 std::map<Instruction*, unsigned> InstRankMap;
42 bool runOnFunction(Function &F);
44 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
48 void BuildRankMap(Function &F);
49 unsigned getRank(Value *V);
50 bool ReassociateExpr(BinaryOperator *I);
51 bool ReassociateBB(BasicBlock *BB);
54 RegisterOpt<Reassociate> X("reassociate", "Reassociate expressions");
57 Pass *createReassociatePass() { return new Reassociate(); }
59 void Reassociate::BuildRankMap(Function &F) {
61 ReversePostOrderTraversal<Function*> RPOT(&F);
62 for (ReversePostOrderTraversal<Function*>::rpo_iterator I = RPOT.begin(),
63 E = RPOT.end(); I != E; ++I)
64 RankMap[*I] = ++i << 16;
67 unsigned Reassociate::getRank(Value *V) {
68 if (isa<Argument>(V)) return 1; // Function argument...
69 if (Instruction *I = dyn_cast<Instruction>(V)) {
70 // If this is an expression, return the 1+MAX(rank(LHS), rank(RHS)) so that
71 // we can reassociate expressions for code motion! Since we do not recurse
72 // for PHI nodes, we cannot have infinite recursion here, because there
73 // cannot be loops in the value graph that do not go through PHI nodes.
75 if (I->getOpcode() == Instruction::PHINode ||
76 I->getOpcode() == Instruction::Alloca ||
77 I->getOpcode() == Instruction::Malloc || isa<TerminatorInst>(I) ||
78 I->mayWriteToMemory()) // Cannot move inst if it writes to memory!
79 return RankMap[I->getParent()];
81 unsigned &CachedRank = InstRankMap[I];
82 if (CachedRank) return CachedRank; // Rank already known?
84 // If not, compute it!
85 unsigned Rank = 0, MaxRank = RankMap[I->getParent()];
86 for (unsigned i = 0, e = I->getNumOperands();
87 i != e && Rank != MaxRank; ++i)
88 Rank = std::max(Rank, getRank(I->getOperand(i)));
90 DEBUG(std::cerr << "Calculated Rank[" << V->getName() << "] = "
93 return CachedRank = Rank+1;
96 // Otherwise it's a global or constant, rank 0.
101 bool Reassociate::ReassociateExpr(BinaryOperator *I) {
102 Value *LHS = I->getOperand(0);
103 Value *RHS = I->getOperand(1);
104 unsigned LHSRank = getRank(LHS);
105 unsigned RHSRank = getRank(RHS);
107 bool Changed = false;
109 // Make sure the LHS of the operand always has the greater rank...
110 if (LHSRank < RHSRank) {
111 bool Success = !I->swapOperands();
112 assert(Success && "swapOperands failed");
115 std::swap(LHSRank, RHSRank);
118 DEBUG(std::cerr << "Transposed: " << I
119 /* << " Result BB: " << I->getParent()*/);
122 // If the LHS is the same operator as the current one is, and if we are the
123 // only expression using it...
125 if (BinaryOperator *LHSI = dyn_cast<BinaryOperator>(LHS))
126 if (LHSI->getOpcode() == I->getOpcode() && LHSI->use_size() == 1) {
127 // If the rank of our current RHS is less than the rank of the LHS's LHS,
128 // then we reassociate the two instructions...
131 if (BinaryOperator *IOp = dyn_cast<BinaryOperator>(LHSI->getOperand(0)))
132 if (IOp->getOpcode() == LHSI->getOpcode())
133 TakeOp = 1; // Hoist out non-tree portion
135 if (RHSRank < getRank(LHSI->getOperand(TakeOp))) {
136 // Convert ((a + 12) + 10) into (a + (12 + 10))
137 I->setOperand(0, LHSI->getOperand(TakeOp));
138 LHSI->setOperand(TakeOp, RHS);
139 I->setOperand(1, LHSI);
141 // Move the LHS expression forward, to ensure that it is dominated by
143 LHSI->getParent()->getInstList().remove(LHSI);
144 I->getParent()->getInstList().insert(I, LHSI);
147 DEBUG(std::cerr << "Reassociated: " << I/* << " Result BB: "
148 << I->getParent()*/);
150 // Since we modified the RHS instruction, make sure that we recheck it.
151 ReassociateExpr(LHSI);
161 // NegateValue - Insert instructions before the instruction pointed to by BI,
162 // that computes the negative version of the value specified. The negative
163 // version of the value is returned, and BI is left pointing at the instruction
164 // that should be processed next by the reassociation pass.
166 static Value *NegateValue(Value *V, BasicBlock::iterator &BI) {
167 // We are trying to expose opportunity for reassociation. One of the things
168 // that we want to do to achieve this is to push a negation as deep into an
169 // expression chain as possible, to expose the add instructions. In practice,
170 // this means that we turn this:
171 // X = -(A+12+C+D) into X = -A + -12 + -C + -D = -12 + -A + -C + -D
172 // so that later, a: Y = 12+X could get reassociated with the -12 to eliminate
173 // the constants. We assume that instcombine will clean up the mess later if
174 // we introduce tons of unneccesary negation instructions...
176 if (Instruction *I = dyn_cast<Instruction>(V))
177 if (I->getOpcode() == Instruction::Add && I->use_size() == 1) {
178 Value *RHS = NegateValue(I->getOperand(1), BI);
179 Value *LHS = NegateValue(I->getOperand(0), BI);
181 // We must actually insert a new add instruction here, because the neg
182 // instructions do not dominate the old add instruction in general. By
183 // adding it now, we are assured that the neg instructions we just
184 // inserted dominate the instruction we are about to insert after them.
186 return BinaryOperator::create(Instruction::Add, LHS, RHS,
188 cast<Instruction>(RHS)->getNext());
191 // Insert a 'neg' instruction that subtracts the value from zero to get the
194 return BI = BinaryOperator::createNeg(V, V->getName() + ".neg", BI);
198 bool Reassociate::ReassociateBB(BasicBlock *BB) {
199 bool Changed = false;
200 for (BasicBlock::iterator BI = BB->begin(); BI != BB->end(); ++BI) {
202 DEBUG(std::cerr << "Processing: " << *BI);
203 if (BI->getOpcode() == Instruction::Sub && !BinaryOperator::isNeg(BI)) {
204 // Convert a subtract into an add and a neg instruction... so that sub
205 // instructions can be commuted with other add instructions...
207 // Calculate the negative value of Operand 1 of the sub instruction...
208 // and set it as the RHS of the add instruction we just made...
210 std::string Name = BI->getName();
213 BinaryOperator::create(Instruction::Add, BI->getOperand(0),
214 BI->getOperand(1), Name, BI);
216 // Everyone now refers to the add instruction...
217 BI->replaceAllUsesWith(New);
219 // Put the new add in the place of the subtract... deleting the subtract
220 BB->getInstList().erase(BI);
223 New->setOperand(1, NegateValue(New->getOperand(1), BI));
226 DEBUG(std::cerr << "Negated: " << New /*<< " Result BB: " << BB*/);
229 // If this instruction is a commutative binary operator, and the ranks of
230 // the two operands are sorted incorrectly, fix it now.
232 if (BI->isAssociative()) {
233 BinaryOperator *I = cast<BinaryOperator>(BI);
234 if (!I->use_empty()) {
235 // Make sure that we don't have a tree-shaped computation. If we do,
236 // linearize it. Convert (A+B)+(C+D) into ((A+B)+C)+D
238 Instruction *LHSI = dyn_cast<Instruction>(I->getOperand(0));
239 Instruction *RHSI = dyn_cast<Instruction>(I->getOperand(1));
240 if (LHSI && (int)LHSI->getOpcode() == I->getOpcode() &&
241 RHSI && (int)RHSI->getOpcode() == I->getOpcode() &&
242 RHSI->use_size() == 1) {
243 // Insert a new temporary instruction... (A+B)+C
244 BinaryOperator *Tmp = BinaryOperator::create(I->getOpcode(), LHSI,
246 RHSI->getName()+".ra",
249 I->setOperand(0, Tmp);
250 I->setOperand(1, RHSI->getOperand(1));
252 // Process the temporary instruction for reassociation now.
256 DEBUG(std::cerr << "Linearized: " << I/* << " Result BB: " << BB*/);
259 // Make sure that this expression is correctly reassociated with respect
260 // to it's used values...
262 Changed |= ReassociateExpr(I);
271 bool Reassociate::runOnFunction(Function &F) {
272 // Recalculate the rank map for F
275 bool Changed = false;
276 for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI)
277 Changed |= ReassociateBB(FI);
279 // We are done with the rank map...