*** empty log message ***
[oota-llvm.git] / lib / Transforms / Scalar / InstructionCombining.cpp
1 //===- InstructionCombining.cpp - Combine multiple instructions -------------=//
2 //
3 // InstructionCombining - Combine instructions to form fewer, simple
4 //   instructions.  This pass does not modify the CFG, and has a tendancy to
5 //   make instructions dead, so a subsequent DIE pass is useful.  This pass is
6 //   where algebraic simplification happens.
7 //
8 // This pass combines things like:
9 //    %Y = add int 1, %X
10 //    %Z = add int 1, %Y
11 // into:
12 //    %Z = add int 2, %X
13 //
14 // This is a simple worklist driven algorithm.
15 //
16 //===----------------------------------------------------------------------===//
17
18 #include "llvm/Transforms/Scalar.h"
19 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
20 #include "llvm/ConstantHandling.h"
21 #include "llvm/iMemory.h"
22 #include "llvm/iOther.h"
23 #include "llvm/iPHINode.h"
24 #include "llvm/iOperators.h"
25 #include "llvm/Pass.h"
26 #include "llvm/Support/InstIterator.h"
27 #include "llvm/Support/InstVisitor.h"
28 #include "Support/StatisticReporter.h"
29 #include <algorithm>
30
31 static Statistic<> NumCombined("instcombine\t- Number of insts combined");
32
33 namespace {
34   class InstCombiner : public FunctionPass,
35                        public InstVisitor<InstCombiner, Instruction*> {
36     // Worklist of all of the instructions that need to be simplified.
37     std::vector<Instruction*> WorkList;
38
39     void AddUsesToWorkList(Instruction &I) {
40       // The instruction was simplified, add all users of the instruction to
41       // the work lists because they might get more simplified now...
42       //
43       for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
44            UI != UE; ++UI)
45         WorkList.push_back(cast<Instruction>(*UI));
46     }
47
48   public:
49     virtual bool runOnFunction(Function &F);
50
51     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
52       AU.preservesCFG();
53     }
54
55     // Visitation implementation - Implement instruction combining for different
56     // instruction types.  The semantics are as follows:
57     // Return Value:
58     //    null        - No change was made
59     //     I          - Change was made, I is still valid
60     //   otherwise    - Change was made, replace I with returned instruction
61     //   
62     Instruction *visitNot(UnaryOperator &I);
63     Instruction *visitAdd(BinaryOperator &I);
64     Instruction *visitSub(BinaryOperator &I);
65     Instruction *visitMul(BinaryOperator &I);
66     Instruction *visitDiv(BinaryOperator &I);
67     Instruction *visitRem(BinaryOperator &I);
68     Instruction *visitAnd(BinaryOperator &I);
69     Instruction *visitOr (BinaryOperator &I);
70     Instruction *visitXor(BinaryOperator &I);
71     Instruction *visitSetCondInst(BinaryOperator &I);
72     Instruction *visitShiftInst(Instruction &I);
73     Instruction *visitCastInst(CastInst &CI);
74     Instruction *visitPHINode(PHINode &PN);
75     Instruction *visitGetElementPtrInst(GetElementPtrInst &GEP);
76     Instruction *visitMemAccessInst(MemAccessInst &MAI);
77
78     // visitInstruction - Specify what to return for unhandled instructions...
79     Instruction *visitInstruction(Instruction &I) { return 0; }
80   };
81
82   RegisterPass<InstCombiner> X("instcombine", "Combine redundant instructions");
83 }
84
85
86 Instruction *InstCombiner::visitNot(UnaryOperator &I) {
87   if (I.use_empty()) return 0;       // Don't fix dead instructions...
88
89   // not (not X) = X
90   if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(0)))
91     if (Op->getOpcode() == Instruction::Not) {
92       AddUsesToWorkList(I);         // Add all modified instrs to worklist
93       I.replaceAllUsesWith(Op->getOperand(0));
94       return &I;
95     }
96   return 0;
97 }
98
99
100 // Make sure that this instruction has a constant on the right hand side if it
101 // has any constant arguments.  If not, fix it an return true.
102 //
103 static bool SimplifyBinOp(BinaryOperator &I) {
104   if (isa<Constant>(I.getOperand(0)) && !isa<Constant>(I.getOperand(1)))
105     return !I.swapOperands();
106   return false;
107 }
108
109 // dyn_castNegInst - Given a 'sub' instruction, return the RHS of the
110 // instruction if the LHS is a constant zero (which is the 'negate' form).
111 //
112 static inline Value *dyn_castNegInst(Value *V) {
113   Instruction *I = dyn_cast<Instruction>(V);
114   if (!I || I->getOpcode() != Instruction::Sub) return 0;
115
116   if (I->getOperand(0) == Constant::getNullValue(I->getType()))
117     return I->getOperand(1);
118   return 0;
119 }
120
121 Instruction *InstCombiner::visitAdd(BinaryOperator &I) {
122   if (I.use_empty()) return 0;       // Don't fix dead add instructions...
123   bool Changed = SimplifyBinOp(I);
124   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
125
126   // Eliminate 'add int %X, 0'
127   if (RHS == Constant::getNullValue(I.getType())) {
128     AddUsesToWorkList(I);         // Add all modified instrs to worklist
129     I.replaceAllUsesWith(LHS);
130     return &I;
131   }
132
133   // -A + B  -->  B - A
134   if (Value *V = dyn_castNegInst(LHS))
135     return BinaryOperator::create(Instruction::Sub, RHS, V);
136
137   // A + -B  -->  A - B
138   if (Value *V = dyn_castNegInst(RHS))
139     return BinaryOperator::create(Instruction::Sub, LHS, V);
140
141   // Simplify add instructions with a constant RHS...
142   if (Constant *Op2 = dyn_cast<Constant>(RHS)) {
143     if (BinaryOperator *ILHS = dyn_cast<BinaryOperator>(LHS)) {
144       if (ILHS->getOpcode() == Instruction::Add &&
145           isa<Constant>(ILHS->getOperand(1))) {
146         // Fold:
147         //    %Y = add int %X, 1
148         //    %Z = add int %Y, 1
149         // into:
150         //    %Z = add int %X, 2
151         //
152         if (Constant *Val = *Op2 + *cast<Constant>(ILHS->getOperand(1))) {
153           I.setOperand(0, ILHS->getOperand(0));
154           I.setOperand(1, Val);
155           return &I;
156         }
157       }
158     }
159   }
160
161   return Changed ? &I : 0;
162 }
163
164 Instruction *InstCombiner::visitSub(BinaryOperator &I) {
165   if (I.use_empty()) return 0;       // Don't fix dead add instructions...
166   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
167
168   if (Op0 == Op1) {         // sub X, X  -> 0
169     AddUsesToWorkList(I);         // Add all modified instrs to worklist
170     I.replaceAllUsesWith(Constant::getNullValue(I.getType()));
171     return &I;
172   }
173
174   // If this is a subtract instruction with a constant RHS, convert it to an add
175   // instruction of a negative constant
176   //
177   if (Constant *Op2 = dyn_cast<Constant>(Op1))
178     if (Constant *RHS = *Constant::getNullValue(I.getType()) - *Op2) // 0 - RHS
179       return BinaryOperator::create(Instruction::Add, Op0, RHS, I.getName());
180
181   // If this is a 'C = x-B', check to see if 'B = -A', so that C = x+A...
182   if (Value *V = dyn_castNegInst(Op1))
183     return BinaryOperator::create(Instruction::Add, Op0, V);
184
185   // Replace (x - (y - z)) with (x + (z - y)) if the (y - z) subexpression is
186   // not used by anyone else...
187   //
188   if (BinaryOperator *Op1I = dyn_cast<BinaryOperator>(Op1))
189     if (Op1I->use_size() == 1 && Op1I->getOpcode() == Instruction::Sub) {
190       // Swap the two operands of the subexpr...
191       Value *IIOp0 = Op1I->getOperand(0), *IIOp1 = Op1I->getOperand(1);
192       Op1I->setOperand(0, IIOp1);
193       Op1I->setOperand(1, IIOp0);
194
195       // Create the new top level add instruction...
196       return BinaryOperator::create(Instruction::Add, Op0, Op1);
197     }
198   return 0;
199 }
200
201 Instruction *InstCombiner::visitMul(BinaryOperator &I) {
202   if (I.use_empty()) return 0;       // Don't fix dead instructions...
203   bool Changed = SimplifyBinOp(I);
204   Value *Op1 = I.getOperand(0);
205
206   // Simplify add instructions with a constant RHS...
207   if (Constant *Op2 = dyn_cast<Constant>(I.getOperand(1))) {
208     if (I.getType()->isIntegral() && cast<ConstantInt>(Op2)->equalsInt(1)){
209       // Eliminate 'mul int %X, 1'
210       AddUsesToWorkList(I);         // Add all modified instrs to worklist
211       I.replaceAllUsesWith(Op1);
212       return &I;
213
214     } else if (I.getType()->isIntegral() &&
215                cast<ConstantInt>(Op2)->equalsInt(2)) {
216       // Convert 'mul int %X, 2' to 'add int %X, %X'
217       return BinaryOperator::create(Instruction::Add, Op1, Op1, I.getName());
218
219     } else if (Op2->isNullValue()) {
220       // Eliminate 'mul int %X, 0'
221       AddUsesToWorkList(I);        // Add all modified instrs to worklist
222       I.replaceAllUsesWith(Op2);   // Set this value to zero directly
223       return &I;
224     }
225   }
226
227   return Changed ? &I : 0;
228 }
229
230
231 Instruction *InstCombiner::visitDiv(BinaryOperator &I) {
232   if (I.use_empty()) return 0;       // Don't fix dead instructions...
233
234   // div X, 1 == X
235   if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1)))
236     if (RHS->equalsInt(1)) {
237       AddUsesToWorkList(I);         // Add all modified instrs to worklist
238       I.replaceAllUsesWith(I.getOperand(0));
239       return &I;
240     }
241   return 0;
242 }
243
244
245 Instruction *InstCombiner::visitRem(BinaryOperator &I) {
246   if (I.use_empty()) return 0;       // Don't fix dead instructions...
247
248   // rem X, 1 == 0
249   if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1)))
250     if (RHS->equalsInt(1)) {
251       AddUsesToWorkList(I);          // Add all modified instrs to worklist
252       I.replaceAllUsesWith(Constant::getNullValue(I.getType()));
253       return &I;
254     }
255   return 0;
256 }
257
258 static Constant *getMaxValue(const Type *Ty) {
259   assert(Ty == Type::BoolTy || Ty->isIntegral());
260   if (Ty == Type::BoolTy)
261     return ConstantBool::True;
262
263   if (Ty->isSigned())
264     return ConstantSInt::get(Ty, -1);
265   else if (Ty->isUnsigned()) {
266     // Calculate -1 casted to the right type...
267     unsigned TypeBits = Ty->getPrimitiveSize()*8;
268     uint64_t Val = (uint64_t)-1LL;       // All ones
269     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
270     return ConstantUInt::get(Ty, Val);
271   }
272   return 0;
273 }
274
275
276 Instruction *InstCombiner::visitAnd(BinaryOperator &I) {
277   if (I.use_empty()) return 0;       // Don't fix dead instructions...
278   bool Changed = SimplifyBinOp(I);
279   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
280
281   // and X, X = X   and X, 0 == 0
282   if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType())) {
283     AddUsesToWorkList(I);            // Add all modified instrs to worklist
284     I.replaceAllUsesWith(Op1);
285     return &I;
286   }
287
288   // and X, -1 == X
289   if (Constant *RHS = dyn_cast<Constant>(Op1))
290     if (RHS == getMaxValue(I.getType())) {
291       AddUsesToWorkList(I);         // Add all modified instrs to worklist
292       I.replaceAllUsesWith(Op0);
293       return &I;
294     }
295
296   return Changed ? &I : 0;
297 }
298
299
300
301 Instruction *InstCombiner::visitOr(BinaryOperator &I) {
302   if (I.use_empty()) return 0;       // Don't fix dead instructions...
303   bool Changed = SimplifyBinOp(I);
304   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
305
306   // or X, X = X   or X, 0 == X
307   if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType())) {
308     AddUsesToWorkList(I);         // Add all modified instrs to worklist
309     I.replaceAllUsesWith(Op0);
310     return &I;
311   }
312
313   // or X, -1 == -1
314   if (Constant *RHS = dyn_cast<Constant>(Op1))
315     if (RHS == getMaxValue(I.getType())) {
316       AddUsesToWorkList(I);         // Add all modified instrs to worklist
317       I.replaceAllUsesWith(Op1);
318       return &I;
319     }
320
321   return Changed ? &I : 0;
322 }
323
324
325
326 Instruction *InstCombiner::visitXor(BinaryOperator &I) {
327   if (I.use_empty()) return 0;       // Don't fix dead instructions...
328   bool Changed = SimplifyBinOp(I);
329   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
330
331   // xor X, X = 0
332   if (Op0 == Op1) {
333     AddUsesToWorkList(I);         // Add all modified instrs to worklist
334     I.replaceAllUsesWith(Constant::getNullValue(I.getType()));
335     return &I;
336   }
337
338   // xor X, 0 == X
339   if (Op1 == Constant::getNullValue(I.getType())) {
340     AddUsesToWorkList(I);         // Add all modified instrs to worklist
341     I.replaceAllUsesWith(Op0);
342     return &I;
343   }
344
345   return Changed ? &I : 0;
346 }
347
348 // isTrueWhenEqual - Return true if the specified setcondinst instruction is
349 // true when both operands are equal...
350 //
351 static bool isTrueWhenEqual(Instruction &I) {
352   return I.getOpcode() == Instruction::SetEQ ||
353          I.getOpcode() == Instruction::SetGE ||
354          I.getOpcode() == Instruction::SetLE;
355 }
356
357 Instruction *InstCombiner::visitSetCondInst(BinaryOperator &I) {
358   if (I.use_empty()) return 0;       // Don't fix dead instructions...
359   bool Changed = SimplifyBinOp(I);
360
361   // setcc X, X
362   if (I.getOperand(0) == I.getOperand(1)) {
363     AddUsesToWorkList(I);         // Add all modified instrs to worklist
364     I.replaceAllUsesWith(ConstantBool::get(isTrueWhenEqual(I)));
365     return &I;
366   }
367
368   // setcc <global*>, 0 - Global value addresses are never null!
369   if (isa<GlobalValue>(I.getOperand(0)) &&
370       isa<ConstantPointerNull>(I.getOperand(1))) {
371     AddUsesToWorkList(I);         // Add all modified instrs to worklist
372     I.replaceAllUsesWith(ConstantBool::get(!isTrueWhenEqual(I)));
373     return &I;
374   }
375
376   return Changed ? &I : 0;
377 }
378
379
380
381 Instruction *InstCombiner::visitShiftInst(Instruction &I) {
382   if (I.use_empty()) return 0;       // Don't fix dead instructions...
383   assert(I.getOperand(1)->getType() == Type::UByteTy);
384   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
385
386   // shl X, 0 == X and shr X, 0 == X
387   // shl 0, X == 0 and shr 0, X == 0
388   if (Op1 == Constant::getNullValue(Type::UByteTy) ||
389       Op0 == Constant::getNullValue(Op0->getType())) {
390     AddUsesToWorkList(I);         // Add all modified instrs to worklist
391     I.replaceAllUsesWith(Op0);
392     return &I;
393   }
394
395   // shl int X, 32 = 0 and shr sbyte Y, 9 = 0, ... just don't eliminate shr of
396   // a signed value.
397   //
398   if (ConstantUInt *CUI = dyn_cast<ConstantUInt>(Op1)) {
399     unsigned TypeBits = Op0->getType()->getPrimitiveSize()*8;
400     if (CUI->getValue() >= TypeBits &&
401         !(Op0->getType()->isSigned() && I.getOpcode() == Instruction::Shr)) {
402       AddUsesToWorkList(I);         // Add all modified instrs to worklist
403       I.replaceAllUsesWith(Constant::getNullValue(Op0->getType()));
404       return &I;
405     }
406   }
407   return 0;
408 }
409
410
411 // isEliminableCastOfCast - Return true if it is valid to eliminate the CI
412 // instruction.
413 //
414 static inline bool isEliminableCastOfCast(const CastInst &CI,
415                                           const CastInst *CSrc) {
416   assert(CI.getOperand(0) == CSrc);
417   const Type *SrcTy = CSrc->getOperand(0)->getType();
418   const Type *MidTy = CSrc->getType();
419   const Type *DstTy = CI.getType();
420
421   // It is legal to eliminate the instruction if casting A->B->A
422   if (SrcTy == DstTy) return true;
423
424   // Allow free casting and conversion of sizes as long as the sign doesn't
425   // change...
426   if (SrcTy->isSigned() == MidTy->isSigned() &&
427       MidTy->isSigned() == DstTy->isSigned())
428     return true;
429
430   // Otherwise, we cannot succeed.  Specifically we do not want to allow things
431   // like:  short -> ushort -> uint, because this can create wrong results if
432   // the input short is negative!
433   //
434   return false;
435 }
436
437
438 // CastInst simplification
439 //
440 Instruction *InstCombiner::visitCastInst(CastInst &CI) {
441   if (CI.use_empty()) return 0;       // Don't fix dead instructions...
442
443   // If the user is casting a value to the same type, eliminate this cast
444   // instruction...
445   if (CI.getType() == CI.getOperand(0)->getType() && !CI.use_empty()) {
446     AddUsesToWorkList(CI);         // Add all modified instrs to worklist
447     CI.replaceAllUsesWith(CI.getOperand(0));
448     return &CI;
449   }
450
451
452   // If casting the result of another cast instruction, try to eliminate this
453   // one!
454   //
455   if (CastInst *CSrc = dyn_cast<CastInst>(CI.getOperand(0)))
456     if (isEliminableCastOfCast(CI, CSrc)) {
457       // This instruction now refers directly to the cast's src operand.  This
458       // has a good chance of making CSrc dead.
459       CI.setOperand(0, CSrc->getOperand(0));
460       return &CI;
461     }
462
463   return 0;
464 }
465
466
467 // PHINode simplification
468 //
469 Instruction *InstCombiner::visitPHINode(PHINode &PN) {
470   if (PN.use_empty()) return 0;       // Don't fix dead instructions...
471
472   // If the PHI node only has one incoming value, eliminate the PHI node...
473   if (PN.getNumIncomingValues() == 1) {
474     AddUsesToWorkList(PN);         // Add all modified instrs to worklist
475     PN.replaceAllUsesWith(PN.getIncomingValue(0));
476     return &PN;
477   }
478
479   return 0;
480 }
481
482
483 Instruction *InstCombiner::visitGetElementPtrInst(GetElementPtrInst &GEP) {
484   // Is it getelementptr %P, uint 0
485   // If so, eliminate the noop.
486   if (GEP.getNumOperands() == 2 && !GEP.use_empty() &&
487       GEP.getOperand(1) == Constant::getNullValue(Type::UIntTy)) {
488     AddUsesToWorkList(GEP);         // Add all modified instrs to worklist
489     GEP.replaceAllUsesWith(GEP.getOperand(0));
490     return &GEP;
491   }
492
493   return visitMemAccessInst(GEP);
494 }
495
496
497 // Combine Indices - If the source pointer to this mem access instruction is a
498 // getelementptr instruction, combine the indices of the GEP into this
499 // instruction
500 //
501 Instruction *InstCombiner::visitMemAccessInst(MemAccessInst &MAI) {
502   return 0;   // DISABLE FOLDING.  GEP is now the only MAI!
503
504   GetElementPtrInst *Src =
505     dyn_cast<GetElementPtrInst>(MAI.getPointerOperand());
506   if (!Src) return 0;
507
508   std::vector<Value *> Indices;
509   
510   // Only special case we have to watch out for is pointer arithmetic on the
511   // 0th index of MAI. 
512   unsigned FirstIdx = MAI.getFirstIndexOperandNumber();
513   if (FirstIdx == MAI.getNumOperands() || 
514       (FirstIdx == MAI.getNumOperands()-1 &&
515        MAI.getOperand(FirstIdx) == ConstantUInt::get(Type::UIntTy, 0))) { 
516     // Replace the index list on this MAI with the index on the getelementptr
517     Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end());
518   } else if (*MAI.idx_begin() == ConstantUInt::get(Type::UIntTy, 0)) { 
519     // Otherwise we can do the fold if the first index of the GEP is a zero
520     Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end());
521     Indices.insert(Indices.end(), MAI.idx_begin()+1, MAI.idx_end());
522   }
523
524   if (Indices.empty()) return 0;  // Can't do the fold?
525
526   switch (MAI.getOpcode()) {
527   case Instruction::GetElementPtr:
528     return new GetElementPtrInst(Src->getOperand(0), Indices, MAI.getName());
529   case Instruction::Load:
530     return new LoadInst(Src->getOperand(0), Indices, MAI.getName());
531   case Instruction::Store:
532     return new StoreInst(MAI.getOperand(0), Src->getOperand(0), Indices);
533   default:
534     assert(0 && "Unknown memaccessinst!");
535     break;
536   }
537   abort();
538   return 0;
539 }
540
541
542 bool InstCombiner::runOnFunction(Function &F) {
543   bool Changed = false;
544
545   WorkList.insert(WorkList.end(), inst_begin(F), inst_end(F));
546
547   while (!WorkList.empty()) {
548     Instruction *I = WorkList.back();  // Get an instruction from the worklist
549     WorkList.pop_back();
550
551     // Now that we have an instruction, try combining it to simplify it...
552     Instruction *Result = visit(*I);
553     if (Result) {
554       ++NumCombined;
555       // Should we replace the old instruction with a new one?
556       if (Result != I) {
557         // Instructions can end up on the worklist more than once.  Make sure
558         // we do not process an instruction that has been deleted.
559         std::vector<Instruction*>::iterator It = std::find(WorkList.begin(),
560                                                            WorkList.end(), I);
561         while (It != WorkList.end()) {
562           It = WorkList.erase(It);
563           It = std::find(It, WorkList.end(), I);
564         }
565
566         ReplaceInstWithInst(I, Result);
567       } else {
568         // FIXME:
569         // FIXME:
570         // FIXME: This should DCE the instruction to simplify the cases above.
571         // FIXME:
572         // FIXME:
573       }
574
575       WorkList.push_back(Result);
576       AddUsesToWorkList(*Result);
577       Changed = true;
578     }
579   }
580
581   return Changed;
582 }
583
584 Pass *createInstructionCombiningPass() {
585   return new InstCombiner();
586 }