Use IRBuilder instead of ConstantInt methods.
[oota-llvm.git] / lib / Transforms / InstCombine / InstCombineMulDivRem.cpp
1 //===- InstCombineMulDivRem.cpp -------------------------------------------===//
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 file implements the visit functions for mul, fmul, sdiv, udiv, fdiv,
11 // srem, urem, frem.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "InstCombine.h"
16 #include "llvm/Analysis/InstructionSimplify.h"
17 #include "llvm/IR/IntrinsicInst.h"
18 #include "llvm/Support/PatternMatch.h"
19 using namespace llvm;
20 using namespace PatternMatch;
21
22
23 /// simplifyValueKnownNonZero - The specific integer value is used in a context
24 /// where it is known to be non-zero.  If this allows us to simplify the
25 /// computation, do so and return the new operand, otherwise return null.
26 static Value *simplifyValueKnownNonZero(Value *V, InstCombiner &IC) {
27   // If V has multiple uses, then we would have to do more analysis to determine
28   // if this is safe.  For example, the use could be in dynamically unreached
29   // code.
30   if (!V->hasOneUse()) return 0;
31
32   bool MadeChange = false;
33
34   // ((1 << A) >>u B) --> (1 << (A-B))
35   // Because V cannot be zero, we know that B is less than A.
36   Value *A = 0, *B = 0, *PowerOf2 = 0;
37   if (match(V, m_LShr(m_OneUse(m_Shl(m_Value(PowerOf2), m_Value(A))),
38                       m_Value(B))) &&
39       // The "1" can be any value known to be a power of 2.
40       isKnownToBeAPowerOfTwo(PowerOf2)) {
41     A = IC.Builder->CreateSub(A, B);
42     return IC.Builder->CreateShl(PowerOf2, A);
43   }
44
45   // (PowerOfTwo >>u B) --> isExact since shifting out the result would make it
46   // inexact.  Similarly for <<.
47   if (BinaryOperator *I = dyn_cast<BinaryOperator>(V))
48     if (I->isLogicalShift() && isKnownToBeAPowerOfTwo(I->getOperand(0))) {
49       // We know that this is an exact/nuw shift and that the input is a
50       // non-zero context as well.
51       if (Value *V2 = simplifyValueKnownNonZero(I->getOperand(0), IC)) {
52         I->setOperand(0, V2);
53         MadeChange = true;
54       }
55
56       if (I->getOpcode() == Instruction::LShr && !I->isExact()) {
57         I->setIsExact();
58         MadeChange = true;
59       }
60
61       if (I->getOpcode() == Instruction::Shl && !I->hasNoUnsignedWrap()) {
62         I->setHasNoUnsignedWrap();
63         MadeChange = true;
64       }
65     }
66
67   // TODO: Lots more we could do here:
68   //    If V is a phi node, we can call this on each of its operands.
69   //    "select cond, X, 0" can simplify to "X".
70
71   return MadeChange ? V : 0;
72 }
73
74
75 /// MultiplyOverflows - True if the multiply can not be expressed in an int
76 /// this size.
77 static bool MultiplyOverflows(ConstantInt *C1, ConstantInt *C2, bool sign) {
78   uint32_t W = C1->getBitWidth();
79   APInt LHSExt = C1->getValue(), RHSExt = C2->getValue();
80   if (sign) {
81     LHSExt = LHSExt.sext(W * 2);
82     RHSExt = RHSExt.sext(W * 2);
83   } else {
84     LHSExt = LHSExt.zext(W * 2);
85     RHSExt = RHSExt.zext(W * 2);
86   }
87
88   APInt MulExt = LHSExt * RHSExt;
89
90   if (!sign)
91     return MulExt.ugt(APInt::getLowBitsSet(W * 2, W));
92
93   APInt Min = APInt::getSignedMinValue(W).sext(W * 2);
94   APInt Max = APInt::getSignedMaxValue(W).sext(W * 2);
95   return MulExt.slt(Min) || MulExt.sgt(Max);
96 }
97
98 /// \brief A helper routine of InstCombiner::visitMul().
99 ///
100 /// If C is a vector of known powers of 2, then this function returns
101 /// a new vector obtained from C replacing each element with its logBase2.
102 /// Return a null pointer otherwise.
103 static Constant *getLogBase2Vector(ConstantDataVector *CV) {
104   const APInt *IVal;
105   SmallVector<Constant *, 4> Elts;
106
107   for (unsigned I = 0, E = CV->getNumElements(); I != E; ++I) {
108     Constant *Elt = CV->getElementAsConstant(I);
109     if (!match(Elt, m_APInt(IVal)) || !IVal->isPowerOf2())
110       return 0;
111     Elts.push_back(ConstantInt::get(Elt->getType(), IVal->logBase2()));
112   }
113
114   return ConstantVector::get(Elts);
115 }
116
117 Instruction *InstCombiner::visitMul(BinaryOperator &I) {
118   bool Changed = SimplifyAssociativeOrCommutative(I);
119   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
120
121   if (Value *V = SimplifyMulInst(Op0, Op1, TD))
122     return ReplaceInstUsesWith(I, V);
123
124   if (Value *V = SimplifyUsingDistributiveLaws(I))
125     return ReplaceInstUsesWith(I, V);
126
127   if (match(Op1, m_AllOnes()))  // X * -1 == 0 - X
128     return BinaryOperator::CreateNeg(Op0, I.getName());
129
130   // Also allow combining multiply instructions on vectors.
131   {
132     Value *NewOp;
133     Constant *C1, *C2;
134     const APInt *IVal;
135     if (match(&I, m_Mul(m_Shl(m_Value(NewOp), m_Constant(C2)),
136                         m_Constant(C1))) &&
137         match(C1, m_APInt(IVal)))
138       // ((X << C1)*C2) == (X * (C2 << C1))
139       return BinaryOperator::CreateMul(NewOp, ConstantExpr::getShl(C1, C2));
140
141     if (match(&I, m_Mul(m_Value(NewOp), m_Constant(C1)))) {
142       Constant *NewCst = 0;
143       if (match(C1, m_APInt(IVal)) && IVal->isPowerOf2())
144         // Replace X*(2^C) with X << C, where C is either a scalar or a splat.
145         NewCst = ConstantInt::get(NewOp->getType(), IVal->logBase2());
146       else if (ConstantDataVector *CV = dyn_cast<ConstantDataVector>(C1))
147         // Replace X*(2^C) with X << C, where C is a vector of known
148         // constant powers of 2.
149         NewCst = getLogBase2Vector(CV);
150
151       if (NewCst) {
152         BinaryOperator *Shl = BinaryOperator::CreateShl(NewOp, NewCst);
153         if (I.hasNoSignedWrap()) Shl->setHasNoSignedWrap();
154         if (I.hasNoUnsignedWrap()) Shl->setHasNoUnsignedWrap();
155         return Shl;
156       }
157     }
158   }
159
160   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
161     // Canonicalize (X+C1)*CI -> X*CI+C1*CI.
162     { Value *X; ConstantInt *C1;
163       if (Op0->hasOneUse() &&
164           match(Op0, m_Add(m_Value(X), m_ConstantInt(C1)))) {
165         Value *Add = Builder->CreateMul(X, CI);
166         return BinaryOperator::CreateAdd(Add, Builder->CreateMul(C1, CI));
167       }
168     }
169
170     // (Y - X) * (-(2**n)) -> (X - Y) * (2**n), for positive nonzero n
171     // (Y + const) * (-(2**n)) -> (-constY) * (2**n), for positive nonzero n
172     // The "* (2**n)" thus becomes a potential shifting opportunity.
173     {
174       const APInt &   Val = CI->getValue();
175       const APInt &PosVal = Val.abs();
176       if (Val.isNegative() && PosVal.isPowerOf2()) {
177         Value *X = 0, *Y = 0;
178         if (Op0->hasOneUse()) {
179           ConstantInt *C1;
180           Value *Sub = 0;
181           if (match(Op0, m_Sub(m_Value(Y), m_Value(X))))
182             Sub = Builder->CreateSub(X, Y, "suba");
183           else if (match(Op0, m_Add(m_Value(Y), m_ConstantInt(C1))))
184             Sub = Builder->CreateSub(Builder->CreateNeg(C1), Y, "subc");
185           if (Sub)
186             return
187               BinaryOperator::CreateMul(Sub,
188                                         ConstantInt::get(Y->getType(), PosVal));
189         }
190       }
191     }
192   }
193
194   // Simplify mul instructions with a constant RHS.
195   if (isa<Constant>(Op1)) {
196     // Try to fold constant mul into select arguments.
197     if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
198       if (Instruction *R = FoldOpIntoSelect(I, SI))
199         return R;
200
201     if (isa<PHINode>(Op0))
202       if (Instruction *NV = FoldOpIntoPhi(I))
203         return NV;
204   }
205
206   if (Value *Op0v = dyn_castNegVal(Op0))     // -X * -Y = X*Y
207     if (Value *Op1v = dyn_castNegVal(Op1))
208       return BinaryOperator::CreateMul(Op0v, Op1v);
209
210   // (X / Y) *  Y = X - (X % Y)
211   // (X / Y) * -Y = (X % Y) - X
212   {
213     Value *Op1C = Op1;
214     BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0);
215     if (!BO ||
216         (BO->getOpcode() != Instruction::UDiv &&
217          BO->getOpcode() != Instruction::SDiv)) {
218       Op1C = Op0;
219       BO = dyn_cast<BinaryOperator>(Op1);
220     }
221     Value *Neg = dyn_castNegVal(Op1C);
222     if (BO && BO->hasOneUse() &&
223         (BO->getOperand(1) == Op1C || BO->getOperand(1) == Neg) &&
224         (BO->getOpcode() == Instruction::UDiv ||
225          BO->getOpcode() == Instruction::SDiv)) {
226       Value *Op0BO = BO->getOperand(0), *Op1BO = BO->getOperand(1);
227
228       // If the division is exact, X % Y is zero, so we end up with X or -X.
229       if (PossiblyExactOperator *SDiv = dyn_cast<PossiblyExactOperator>(BO))
230         if (SDiv->isExact()) {
231           if (Op1BO == Op1C)
232             return ReplaceInstUsesWith(I, Op0BO);
233           return BinaryOperator::CreateNeg(Op0BO);
234         }
235
236       Value *Rem;
237       if (BO->getOpcode() == Instruction::UDiv)
238         Rem = Builder->CreateURem(Op0BO, Op1BO);
239       else
240         Rem = Builder->CreateSRem(Op0BO, Op1BO);
241       Rem->takeName(BO);
242
243       if (Op1BO == Op1C)
244         return BinaryOperator::CreateSub(Op0BO, Rem);
245       return BinaryOperator::CreateSub(Rem, Op0BO);
246     }
247   }
248
249   /// i1 mul -> i1 and.
250   if (I.getType()->isIntegerTy(1))
251     return BinaryOperator::CreateAnd(Op0, Op1);
252
253   // X*(1 << Y) --> X << Y
254   // (1 << Y)*X --> X << Y
255   {
256     Value *Y;
257     if (match(Op0, m_Shl(m_One(), m_Value(Y))))
258       return BinaryOperator::CreateShl(Op1, Y);
259     if (match(Op1, m_Shl(m_One(), m_Value(Y))))
260       return BinaryOperator::CreateShl(Op0, Y);
261   }
262
263   // If one of the operands of the multiply is a cast from a boolean value, then
264   // we know the bool is either zero or one, so this is a 'masking' multiply.
265   //   X * Y (where Y is 0 or 1) -> X & (0-Y)
266   if (!I.getType()->isVectorTy()) {
267     // -2 is "-1 << 1" so it is all bits set except the low one.
268     APInt Negative2(I.getType()->getPrimitiveSizeInBits(), (uint64_t)-2, true);
269
270     Value *BoolCast = 0, *OtherOp = 0;
271     if (MaskedValueIsZero(Op0, Negative2))
272       BoolCast = Op0, OtherOp = Op1;
273     else if (MaskedValueIsZero(Op1, Negative2))
274       BoolCast = Op1, OtherOp = Op0;
275
276     if (BoolCast) {
277       Value *V = Builder->CreateSub(Constant::getNullValue(I.getType()),
278                                     BoolCast);
279       return BinaryOperator::CreateAnd(V, OtherOp);
280     }
281   }
282
283   return Changed ? &I : 0;
284 }
285
286 //
287 // Detect pattern:
288 //
289 // log2(Y*0.5)
290 //
291 // And check for corresponding fast math flags
292 //
293
294 static void detectLog2OfHalf(Value *&Op, Value *&Y, IntrinsicInst *&Log2) {
295
296    if (!Op->hasOneUse())
297      return;
298
299    IntrinsicInst *II = dyn_cast<IntrinsicInst>(Op);
300    if (!II)
301      return;
302    if (II->getIntrinsicID() != Intrinsic::log2 || !II->hasUnsafeAlgebra())
303      return;
304    Log2 = II;
305
306    Value *OpLog2Of = II->getArgOperand(0);
307    if (!OpLog2Of->hasOneUse())
308      return;
309
310    Instruction *I = dyn_cast<Instruction>(OpLog2Of);
311    if (!I)
312      return;
313    if (I->getOpcode() != Instruction::FMul || !I->hasUnsafeAlgebra())
314      return;
315
316    ConstantFP *CFP = dyn_cast<ConstantFP>(I->getOperand(0));
317    if (CFP && CFP->isExactlyValue(0.5)) {
318      Y = I->getOperand(1);
319      return;
320    }
321    CFP = dyn_cast<ConstantFP>(I->getOperand(1));
322    if (CFP && CFP->isExactlyValue(0.5))
323      Y = I->getOperand(0);
324 }
325
326 /// Helper function of InstCombiner::visitFMul(BinaryOperator(). It returns
327 /// true iff the given value is FMul or FDiv with one and only one operand
328 /// being a normal constant (i.e. not Zero/NaN/Infinity).
329 static bool isFMulOrFDivWithConstant(Value *V) {
330   Instruction *I = dyn_cast<Instruction>(V);
331   if (!I || (I->getOpcode() != Instruction::FMul &&
332              I->getOpcode() != Instruction::FDiv))
333     return false;
334
335   ConstantFP *C0 = dyn_cast<ConstantFP>(I->getOperand(0));
336   ConstantFP *C1 = dyn_cast<ConstantFP>(I->getOperand(1));
337
338   if (C0 && C1)
339     return false;
340
341   return (C0 && C0->getValueAPF().isNormal()) ||
342          (C1 && C1->getValueAPF().isNormal());
343 }
344
345 static bool isNormalFp(const ConstantFP *C) {
346   const APFloat &Flt = C->getValueAPF();
347   return Flt.isNormal() && !Flt.isDenormal();
348 }
349
350 /// foldFMulConst() is a helper routine of InstCombiner::visitFMul().
351 /// The input \p FMulOrDiv is a FMul/FDiv with one and only one operand
352 /// being a constant (i.e. isFMulOrFDivWithConstant(FMulOrDiv) == true).
353 /// This function is to simplify "FMulOrDiv * C" and returns the
354 /// resulting expression. Note that this function could return NULL in
355 /// case the constants cannot be folded into a normal floating-point.
356 ///
357 Value *InstCombiner::foldFMulConst(Instruction *FMulOrDiv, ConstantFP *C,
358                                    Instruction *InsertBefore) {
359   assert(isFMulOrFDivWithConstant(FMulOrDiv) && "V is invalid");
360
361   Value *Opnd0 = FMulOrDiv->getOperand(0);
362   Value *Opnd1 = FMulOrDiv->getOperand(1);
363
364   ConstantFP *C0 = dyn_cast<ConstantFP>(Opnd0);
365   ConstantFP *C1 = dyn_cast<ConstantFP>(Opnd1);
366
367   BinaryOperator *R = 0;
368
369   // (X * C0) * C => X * (C0*C)
370   if (FMulOrDiv->getOpcode() == Instruction::FMul) {
371     Constant *F = ConstantExpr::getFMul(C1 ? C1 : C0, C);
372     if (isNormalFp(cast<ConstantFP>(F)))
373       R = BinaryOperator::CreateFMul(C1 ? Opnd0 : Opnd1, F);
374   } else {
375     if (C0) {
376       // (C0 / X) * C => (C0 * C) / X
377       ConstantFP *F = cast<ConstantFP>(ConstantExpr::getFMul(C0, C));
378       if (isNormalFp(F))
379         R = BinaryOperator::CreateFDiv(F, Opnd1);
380     } else {
381       // (X / C1) * C => X * (C/C1) if C/C1 is not a denormal
382       ConstantFP *F = cast<ConstantFP>(ConstantExpr::getFDiv(C, C1));
383       if (isNormalFp(F)) {
384         R = BinaryOperator::CreateFMul(Opnd0, F);
385       } else {
386         // (X / C1) * C => X / (C1/C)
387         Constant *F = ConstantExpr::getFDiv(C1, C);
388         if (isNormalFp(cast<ConstantFP>(F)))
389           R = BinaryOperator::CreateFDiv(Opnd0, F);
390       }
391     }
392   }
393
394   if (R) {
395     R->setHasUnsafeAlgebra(true);
396     InsertNewInstWith(R, *InsertBefore);
397   }
398
399   return R;
400 }
401
402 Instruction *InstCombiner::visitFMul(BinaryOperator &I) {
403   bool Changed = SimplifyAssociativeOrCommutative(I);
404   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
405
406   if (isa<Constant>(Op0))
407     std::swap(Op0, Op1);
408
409   if (Value *V = SimplifyFMulInst(Op0, Op1, I.getFastMathFlags(), TD))
410     return ReplaceInstUsesWith(I, V);
411
412   bool AllowReassociate = I.hasUnsafeAlgebra();
413
414   // Simplify mul instructions with a constant RHS.
415   if (isa<Constant>(Op1)) {
416     // Try to fold constant mul into select arguments.
417     if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
418       if (Instruction *R = FoldOpIntoSelect(I, SI))
419         return R;
420
421     if (isa<PHINode>(Op0))
422       if (Instruction *NV = FoldOpIntoPhi(I))
423         return NV;
424
425     ConstantFP *C = dyn_cast<ConstantFP>(Op1);
426     if (C && AllowReassociate && C->getValueAPF().isNormal()) {
427       // Let MDC denote an expression in one of these forms:
428       // X * C, C/X, X/C, where C is a constant.
429       //
430       // Try to simplify "MDC * Constant"
431       if (isFMulOrFDivWithConstant(Op0)) {
432         Value *V = foldFMulConst(cast<Instruction>(Op0), C, &I);
433         if (V)
434           return ReplaceInstUsesWith(I, V);
435       }
436
437       // (MDC +/- C1) * C => (MDC * C) +/- (C1 * C)
438       Instruction *FAddSub = dyn_cast<Instruction>(Op0);
439       if (FAddSub &&
440           (FAddSub->getOpcode() == Instruction::FAdd ||
441            FAddSub->getOpcode() == Instruction::FSub)) {
442         Value *Opnd0 = FAddSub->getOperand(0);
443         Value *Opnd1 = FAddSub->getOperand(1);
444         ConstantFP *C0 = dyn_cast<ConstantFP>(Opnd0);
445         ConstantFP *C1 = dyn_cast<ConstantFP>(Opnd1);
446         bool Swap = false;
447         if (C0) {
448           std::swap(C0, C1);
449           std::swap(Opnd0, Opnd1);
450           Swap = true;
451         }
452
453         if (C1 && C1->getValueAPF().isNormal() &&
454             isFMulOrFDivWithConstant(Opnd0)) {
455           Value *M1 = ConstantExpr::getFMul(C1, C);
456           Value *M0 = isNormalFp(cast<ConstantFP>(M1)) ?
457                       foldFMulConst(cast<Instruction>(Opnd0), C, &I) :
458                       0;
459           if (M0 && M1) {
460             if (Swap && FAddSub->getOpcode() == Instruction::FSub)
461               std::swap(M0, M1);
462
463             Value *R = (FAddSub->getOpcode() == Instruction::FAdd) ?
464                         BinaryOperator::CreateFAdd(M0, M1) :
465                         BinaryOperator::CreateFSub(M0, M1);
466             Instruction *RI = cast<Instruction>(R);
467             RI->copyFastMathFlags(&I);
468             return RI;
469           }
470         }
471       }
472     }
473   }
474
475
476   // Under unsafe algebra do:
477   // X * log2(0.5*Y) = X*log2(Y) - X
478   if (I.hasUnsafeAlgebra()) {
479     Value *OpX = NULL;
480     Value *OpY = NULL;
481     IntrinsicInst *Log2;
482     detectLog2OfHalf(Op0, OpY, Log2);
483     if (OpY) {
484       OpX = Op1;
485     } else {
486       detectLog2OfHalf(Op1, OpY, Log2);
487       if (OpY) {
488         OpX = Op0;
489       }
490     }
491     // if pattern detected emit alternate sequence
492     if (OpX && OpY) {
493       Log2->setArgOperand(0, OpY);
494       Value *FMulVal = Builder->CreateFMul(OpX, Log2);
495       Instruction *FMul = cast<Instruction>(FMulVal);
496       FMul->copyFastMathFlags(Log2);
497       Instruction *FSub = BinaryOperator::CreateFSub(FMulVal, OpX);
498       FSub->copyFastMathFlags(Log2);
499       return FSub;
500     }
501   }
502
503   // Handle symmetric situation in a 2-iteration loop
504   Value *Opnd0 = Op0;
505   Value *Opnd1 = Op1;
506   for (int i = 0; i < 2; i++) {
507     bool IgnoreZeroSign = I.hasNoSignedZeros();
508     if (BinaryOperator::isFNeg(Opnd0, IgnoreZeroSign)) {
509       Value *N0 = dyn_castFNegVal(Opnd0, IgnoreZeroSign);
510       Value *N1 = dyn_castFNegVal(Opnd1, IgnoreZeroSign);
511
512       // -X * -Y => X*Y
513       if (N1)
514         return BinaryOperator::CreateFMul(N0, N1);
515
516       if (Opnd0->hasOneUse()) {
517         // -X * Y => -(X*Y) (Promote negation as high as possible)
518         Value *T = Builder->CreateFMul(N0, Opnd1);
519         cast<Instruction>(T)->setDebugLoc(I.getDebugLoc());
520         Instruction *Neg = BinaryOperator::CreateFNeg(T);
521         if (I.getFastMathFlags().any()) {
522           cast<Instruction>(T)->copyFastMathFlags(&I);
523           Neg->copyFastMathFlags(&I);
524         }
525         return Neg;
526       }
527     }
528
529     // (X*Y) * X => (X*X) * Y where Y != X
530     //  The purpose is two-fold:
531     //   1) to form a power expression (of X).
532     //   2) potentially shorten the critical path: After transformation, the
533     //  latency of the instruction Y is amortized by the expression of X*X,
534     //  and therefore Y is in a "less critical" position compared to what it
535     //  was before the transformation.
536     //
537     if (AllowReassociate) {
538       Value *Opnd0_0, *Opnd0_1;
539       if (Opnd0->hasOneUse() &&
540           match(Opnd0, m_FMul(m_Value(Opnd0_0), m_Value(Opnd0_1)))) {
541         Value *Y = 0;
542         if (Opnd0_0 == Opnd1 && Opnd0_1 != Opnd1)
543           Y = Opnd0_1;
544         else if (Opnd0_1 == Opnd1 && Opnd0_0 != Opnd1)
545           Y = Opnd0_0;
546
547         if (Y) {
548           Instruction *T = cast<Instruction>(Builder->CreateFMul(Opnd1, Opnd1));
549           T->copyFastMathFlags(&I);
550           T->setDebugLoc(I.getDebugLoc());
551
552           Instruction *R = BinaryOperator::CreateFMul(T, Y);
553           R->copyFastMathFlags(&I);
554           return R;
555         }
556       }
557     }
558
559     if (!isa<Constant>(Op1))
560       std::swap(Opnd0, Opnd1);
561     else
562       break;
563   }
564
565   return Changed ? &I : 0;
566 }
567
568 /// SimplifyDivRemOfSelect - Try to fold a divide or remainder of a select
569 /// instruction.
570 bool InstCombiner::SimplifyDivRemOfSelect(BinaryOperator &I) {
571   SelectInst *SI = cast<SelectInst>(I.getOperand(1));
572
573   // div/rem X, (Cond ? 0 : Y) -> div/rem X, Y
574   int NonNullOperand = -1;
575   if (Constant *ST = dyn_cast<Constant>(SI->getOperand(1)))
576     if (ST->isNullValue())
577       NonNullOperand = 2;
578   // div/rem X, (Cond ? Y : 0) -> div/rem X, Y
579   if (Constant *ST = dyn_cast<Constant>(SI->getOperand(2)))
580     if (ST->isNullValue())
581       NonNullOperand = 1;
582
583   if (NonNullOperand == -1)
584     return false;
585
586   Value *SelectCond = SI->getOperand(0);
587
588   // Change the div/rem to use 'Y' instead of the select.
589   I.setOperand(1, SI->getOperand(NonNullOperand));
590
591   // Okay, we know we replace the operand of the div/rem with 'Y' with no
592   // problem.  However, the select, or the condition of the select may have
593   // multiple uses.  Based on our knowledge that the operand must be non-zero,
594   // propagate the known value for the select into other uses of it, and
595   // propagate a known value of the condition into its other users.
596
597   // If the select and condition only have a single use, don't bother with this,
598   // early exit.
599   if (SI->use_empty() && SelectCond->hasOneUse())
600     return true;
601
602   // Scan the current block backward, looking for other uses of SI.
603   BasicBlock::iterator BBI = &I, BBFront = I.getParent()->begin();
604
605   while (BBI != BBFront) {
606     --BBI;
607     // If we found a call to a function, we can't assume it will return, so
608     // information from below it cannot be propagated above it.
609     if (isa<CallInst>(BBI) && !isa<IntrinsicInst>(BBI))
610       break;
611
612     // Replace uses of the select or its condition with the known values.
613     for (Instruction::op_iterator I = BBI->op_begin(), E = BBI->op_end();
614          I != E; ++I) {
615       if (*I == SI) {
616         *I = SI->getOperand(NonNullOperand);
617         Worklist.Add(BBI);
618       } else if (*I == SelectCond) {
619         *I = NonNullOperand == 1 ? ConstantInt::getTrue(BBI->getContext()) :
620                                    ConstantInt::getFalse(BBI->getContext());
621         Worklist.Add(BBI);
622       }
623     }
624
625     // If we past the instruction, quit looking for it.
626     if (&*BBI == SI)
627       SI = 0;
628     if (&*BBI == SelectCond)
629       SelectCond = 0;
630
631     // If we ran out of things to eliminate, break out of the loop.
632     if (SelectCond == 0 && SI == 0)
633       break;
634
635   }
636   return true;
637 }
638
639
640 /// This function implements the transforms common to both integer division
641 /// instructions (udiv and sdiv). It is called by the visitors to those integer
642 /// division instructions.
643 /// @brief Common integer divide transforms
644 Instruction *InstCombiner::commonIDivTransforms(BinaryOperator &I) {
645   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
646
647   // The RHS is known non-zero.
648   if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this)) {
649     I.setOperand(1, V);
650     return &I;
651   }
652
653   // Handle cases involving: [su]div X, (select Cond, Y, Z)
654   // This does not apply for fdiv.
655   if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
656     return &I;
657
658   if (ConstantInt *RHS = dyn_cast<ConstantInt>(Op1)) {
659     // (X / C1) / C2  -> X / (C1*C2)
660     if (Instruction *LHS = dyn_cast<Instruction>(Op0))
661       if (Instruction::BinaryOps(LHS->getOpcode()) == I.getOpcode())
662         if (ConstantInt *LHSRHS = dyn_cast<ConstantInt>(LHS->getOperand(1))) {
663           if (MultiplyOverflows(RHS, LHSRHS,
664                                 I.getOpcode()==Instruction::SDiv))
665             return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
666           return BinaryOperator::Create(I.getOpcode(), LHS->getOperand(0),
667                                         ConstantExpr::getMul(RHS, LHSRHS));
668         }
669
670     if (!RHS->isZero()) { // avoid X udiv 0
671       if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
672         if (Instruction *R = FoldOpIntoSelect(I, SI))
673           return R;
674       if (isa<PHINode>(Op0))
675         if (Instruction *NV = FoldOpIntoPhi(I))
676           return NV;
677     }
678   }
679
680   // See if we can fold away this div instruction.
681   if (SimplifyDemandedInstructionBits(I))
682     return &I;
683
684   // (X - (X rem Y)) / Y -> X / Y; usually originates as ((X / Y) * Y) / Y
685   Value *X = 0, *Z = 0;
686   if (match(Op0, m_Sub(m_Value(X), m_Value(Z)))) { // (X - Z) / Y; Y = Op1
687     bool isSigned = I.getOpcode() == Instruction::SDiv;
688     if ((isSigned && match(Z, m_SRem(m_Specific(X), m_Specific(Op1)))) ||
689         (!isSigned && match(Z, m_URem(m_Specific(X), m_Specific(Op1)))))
690       return BinaryOperator::Create(I.getOpcode(), X, Op1);
691   }
692
693   return 0;
694 }
695
696 /// dyn_castZExtVal - Checks if V is a zext or constant that can
697 /// be truncated to Ty without losing bits.
698 static Value *dyn_castZExtVal(Value *V, Type *Ty) {
699   if (ZExtInst *Z = dyn_cast<ZExtInst>(V)) {
700     if (Z->getSrcTy() == Ty)
701       return Z->getOperand(0);
702   } else if (ConstantInt *C = dyn_cast<ConstantInt>(V)) {
703     if (C->getValue().getActiveBits() <= cast<IntegerType>(Ty)->getBitWidth())
704       return ConstantExpr::getTrunc(C, Ty);
705   }
706   return 0;
707 }
708
709 Instruction *InstCombiner::visitUDiv(BinaryOperator &I) {
710   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
711
712   if (Value *V = SimplifyUDivInst(Op0, Op1, TD))
713     return ReplaceInstUsesWith(I, V);
714
715   // Handle the integer div common cases
716   if (Instruction *Common = commonIDivTransforms(I))
717     return Common;
718
719   {
720     // X udiv 2^C -> X >> C
721     // Check to see if this is an unsigned division with an exact power of 2,
722     // if so, convert to a right shift.
723     const APInt *C;
724     if (match(Op1, m_Power2(C))) {
725       BinaryOperator *LShr =
726       BinaryOperator::CreateLShr(Op0,
727                                  ConstantInt::get(Op0->getType(),
728                                                   C->logBase2()));
729       if (I.isExact()) LShr->setIsExact();
730       return LShr;
731     }
732   }
733
734   if (ConstantInt *C = dyn_cast<ConstantInt>(Op1)) {
735     // X udiv C, where C >= signbit
736     if (C->getValue().isNegative()) {
737       Value *IC = Builder->CreateICmpULT(Op0, C);
738       return SelectInst::Create(IC, Constant::getNullValue(I.getType()),
739                                 ConstantInt::get(I.getType(), 1));
740     }
741   }
742
743   // (x lshr C1) udiv C2 --> x udiv (C2 << C1)
744   if (ConstantInt *C2 = dyn_cast<ConstantInt>(Op1)) {
745     Value *X;
746     ConstantInt *C1;
747     if (match(Op0, m_LShr(m_Value(X), m_ConstantInt(C1)))) {
748       APInt NC = C2->getValue().shl(C1->getLimitedValue(C1->getBitWidth()-1));
749       return BinaryOperator::CreateUDiv(X, Builder->getInt(NC));
750     }
751   }
752
753   // X udiv (C1 << N), where C1 is "1<<C2"  -->  X >> (N+C2)
754   { const APInt *CI; Value *N;
755     if (match(Op1, m_Shl(m_Power2(CI), m_Value(N))) ||
756         match(Op1, m_ZExt(m_Shl(m_Power2(CI), m_Value(N))))) {
757       if (*CI != 1)
758         N = Builder->CreateAdd(N,
759                                ConstantInt::get(N->getType(), CI->logBase2()));
760       if (ZExtInst *Z = dyn_cast<ZExtInst>(Op1))
761         N = Builder->CreateZExt(N, Z->getDestTy());
762       if (I.isExact())
763         return BinaryOperator::CreateExactLShr(Op0, N);
764       return BinaryOperator::CreateLShr(Op0, N);
765     }
766   }
767
768   // udiv X, (Select Cond, C1, C2) --> Select Cond, (shr X, C1), (shr X, C2)
769   // where C1&C2 are powers of two.
770   { Value *Cond; const APInt *C1, *C2;
771     if (match(Op1, m_Select(m_Value(Cond), m_Power2(C1), m_Power2(C2)))) {
772       // Construct the "on true" case of the select
773       Value *TSI = Builder->CreateLShr(Op0, C1->logBase2(), Op1->getName()+".t",
774                                        I.isExact());
775
776       // Construct the "on false" case of the select
777       Value *FSI = Builder->CreateLShr(Op0, C2->logBase2(), Op1->getName()+".f",
778                                        I.isExact());
779
780       // construct the select instruction and return it.
781       return SelectInst::Create(Cond, TSI, FSI);
782     }
783   }
784
785   // (zext A) udiv (zext B) --> zext (A udiv B)
786   if (ZExtInst *ZOp0 = dyn_cast<ZExtInst>(Op0))
787     if (Value *ZOp1 = dyn_castZExtVal(Op1, ZOp0->getSrcTy()))
788       return new ZExtInst(Builder->CreateUDiv(ZOp0->getOperand(0), ZOp1, "div",
789                                               I.isExact()),
790                           I.getType());
791
792   return 0;
793 }
794
795 Instruction *InstCombiner::visitSDiv(BinaryOperator &I) {
796   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
797
798   if (Value *V = SimplifySDivInst(Op0, Op1, TD))
799     return ReplaceInstUsesWith(I, V);
800
801   // Handle the integer div common cases
802   if (Instruction *Common = commonIDivTransforms(I))
803     return Common;
804
805   if (ConstantInt *RHS = dyn_cast<ConstantInt>(Op1)) {
806     // sdiv X, -1 == -X
807     if (RHS->isAllOnesValue())
808       return BinaryOperator::CreateNeg(Op0);
809
810     // sdiv X, C  -->  ashr exact X, log2(C)
811     if (I.isExact() && RHS->getValue().isNonNegative() &&
812         RHS->getValue().isPowerOf2()) {
813       Value *ShAmt = llvm::ConstantInt::get(RHS->getType(),
814                                             RHS->getValue().exactLogBase2());
815       return BinaryOperator::CreateExactAShr(Op0, ShAmt, I.getName());
816     }
817
818     // -X/C  -->  X/-C  provided the negation doesn't overflow.
819     if (SubOperator *Sub = dyn_cast<SubOperator>(Op0))
820       if (match(Sub->getOperand(0), m_Zero()) && Sub->hasNoSignedWrap())
821         return BinaryOperator::CreateSDiv(Sub->getOperand(1),
822                                           ConstantExpr::getNeg(RHS));
823   }
824
825   // If the sign bits of both operands are zero (i.e. we can prove they are
826   // unsigned inputs), turn this into a udiv.
827   if (I.getType()->isIntegerTy()) {
828     APInt Mask(APInt::getSignBit(I.getType()->getPrimitiveSizeInBits()));
829     if (MaskedValueIsZero(Op0, Mask)) {
830       if (MaskedValueIsZero(Op1, Mask)) {
831         // X sdiv Y -> X udiv Y, iff X and Y don't have sign bit set
832         return BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
833       }
834
835       if (match(Op1, m_Shl(m_Power2(), m_Value()))) {
836         // X sdiv (1 << Y) -> X udiv (1 << Y) ( -> X u>> Y)
837         // Safe because the only negative value (1 << Y) can take on is
838         // INT_MIN, and X sdiv INT_MIN == X udiv INT_MIN == 0 if X doesn't have
839         // the sign bit set.
840         return BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
841       }
842     }
843   }
844
845   return 0;
846 }
847
848 /// CvtFDivConstToReciprocal tries to convert X/C into X*1/C if C not a special
849 /// FP value and:
850 ///    1) 1/C is exact, or
851 ///    2) reciprocal is allowed.
852 /// If the conversion was successful, the simplified expression "X * 1/C" is
853 /// returned; otherwise, NULL is returned.
854 ///
855 static Instruction *CvtFDivConstToReciprocal(Value *Dividend,
856                                              ConstantFP *Divisor,
857                                              bool AllowReciprocal) {
858   const APFloat &FpVal = Divisor->getValueAPF();
859   APFloat Reciprocal(FpVal.getSemantics());
860   bool Cvt = FpVal.getExactInverse(&Reciprocal);
861
862   if (!Cvt && AllowReciprocal && FpVal.isNormal()) {
863     Reciprocal = APFloat(FpVal.getSemantics(), 1.0f);
864     (void)Reciprocal.divide(FpVal, APFloat::rmNearestTiesToEven);
865     Cvt = !Reciprocal.isDenormal();
866   }
867
868   if (!Cvt)
869     return 0;
870
871   ConstantFP *R;
872   R = ConstantFP::get(Dividend->getType()->getContext(), Reciprocal);
873   return BinaryOperator::CreateFMul(Dividend, R);
874 }
875
876 Instruction *InstCombiner::visitFDiv(BinaryOperator &I) {
877   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
878
879   if (Value *V = SimplifyFDivInst(Op0, Op1, TD))
880     return ReplaceInstUsesWith(I, V);
881
882   bool AllowReassociate = I.hasUnsafeAlgebra();
883   bool AllowReciprocal = I.hasAllowReciprocal();
884
885   if (ConstantFP *Op1C = dyn_cast<ConstantFP>(Op1)) {
886     if (AllowReassociate) {
887       ConstantFP *C1 = 0;
888       ConstantFP *C2 = Op1C;
889       Value *X;
890       Instruction *Res = 0;
891
892       if (match(Op0, m_FMul(m_Value(X), m_ConstantFP(C1)))) {
893         // (X*C1)/C2 => X * (C1/C2)
894         //
895         Constant *C = ConstantExpr::getFDiv(C1, C2);
896         const APFloat &F = cast<ConstantFP>(C)->getValueAPF();
897         if (F.isNormal() && !F.isDenormal())
898           Res = BinaryOperator::CreateFMul(X, C);
899       } else if (match(Op0, m_FDiv(m_Value(X), m_ConstantFP(C1)))) {
900         // (X/C1)/C2 => X /(C2*C1) [=> X * 1/(C2*C1) if reciprocal is allowed]
901         //
902         Constant *C = ConstantExpr::getFMul(C1, C2);
903         const APFloat &F = cast<ConstantFP>(C)->getValueAPF();
904         if (F.isNormal() && !F.isDenormal()) {
905           Res = CvtFDivConstToReciprocal(X, cast<ConstantFP>(C),
906                                          AllowReciprocal);
907           if (!Res)
908             Res = BinaryOperator::CreateFDiv(X, C);
909         }
910       }
911
912       if (Res) {
913         Res->setFastMathFlags(I.getFastMathFlags());
914         return Res;
915       }
916     }
917
918     // X / C => X * 1/C
919     if (Instruction *T = CvtFDivConstToReciprocal(Op0, Op1C, AllowReciprocal))
920       return T;
921
922     return 0;
923   }
924
925   if (AllowReassociate && isa<ConstantFP>(Op0)) {
926     ConstantFP *C1 = cast<ConstantFP>(Op0), *C2;
927     Constant *Fold = 0;
928     Value *X;
929     bool CreateDiv = true;
930
931     // C1 / (X*C2) => (C1/C2) / X
932     if (match(Op1, m_FMul(m_Value(X), m_ConstantFP(C2))))
933       Fold = ConstantExpr::getFDiv(C1, C2);
934     else if (match(Op1, m_FDiv(m_Value(X), m_ConstantFP(C2)))) {
935       // C1 / (X/C2) => (C1*C2) / X
936       Fold = ConstantExpr::getFMul(C1, C2);
937     } else if (match(Op1, m_FDiv(m_ConstantFP(C2), m_Value(X)))) {
938       // C1 / (C2/X) => (C1/C2) * X
939       Fold = ConstantExpr::getFDiv(C1, C2);
940       CreateDiv = false;
941     }
942
943     if (Fold) {
944       const APFloat &FoldC = cast<ConstantFP>(Fold)->getValueAPF();
945       if (FoldC.isNormal() && !FoldC.isDenormal()) {
946         Instruction *R = CreateDiv ?
947                          BinaryOperator::CreateFDiv(Fold, X) :
948                          BinaryOperator::CreateFMul(X, Fold);
949         R->setFastMathFlags(I.getFastMathFlags());
950         return R;
951       }
952     }
953     return 0;
954   }
955
956   if (AllowReassociate) {
957     Value *X, *Y;
958     Value *NewInst = 0;
959     Instruction *SimpR = 0;
960
961     if (Op0->hasOneUse() && match(Op0, m_FDiv(m_Value(X), m_Value(Y)))) {
962       // (X/Y) / Z => X / (Y*Z)
963       //
964       if (!isa<ConstantFP>(Y) || !isa<ConstantFP>(Op1)) {
965         NewInst = Builder->CreateFMul(Y, Op1);
966         SimpR = BinaryOperator::CreateFDiv(X, NewInst);
967       }
968     } else if (Op1->hasOneUse() && match(Op1, m_FDiv(m_Value(X), m_Value(Y)))) {
969       // Z / (X/Y) => Z*Y / X
970       //
971       if (!isa<ConstantFP>(Y) || !isa<ConstantFP>(Op0)) {
972         NewInst = Builder->CreateFMul(Op0, Y);
973         SimpR = BinaryOperator::CreateFDiv(NewInst, X);
974       }
975     }
976
977     if (NewInst) {
978       if (Instruction *T = dyn_cast<Instruction>(NewInst))
979         T->setDebugLoc(I.getDebugLoc());
980       SimpR->setFastMathFlags(I.getFastMathFlags());
981       return SimpR;
982     }
983   }
984
985   return 0;
986 }
987
988 /// This function implements the transforms common to both integer remainder
989 /// instructions (urem and srem). It is called by the visitors to those integer
990 /// remainder instructions.
991 /// @brief Common integer remainder transforms
992 Instruction *InstCombiner::commonIRemTransforms(BinaryOperator &I) {
993   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
994
995   // The RHS is known non-zero.
996   if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this)) {
997     I.setOperand(1, V);
998     return &I;
999   }
1000
1001   // Handle cases involving: rem X, (select Cond, Y, Z)
1002   if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
1003     return &I;
1004
1005   if (isa<ConstantInt>(Op1)) {
1006     if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
1007       if (SelectInst *SI = dyn_cast<SelectInst>(Op0I)) {
1008         if (Instruction *R = FoldOpIntoSelect(I, SI))
1009           return R;
1010       } else if (isa<PHINode>(Op0I)) {
1011         if (Instruction *NV = FoldOpIntoPhi(I))
1012           return NV;
1013       }
1014
1015       // See if we can fold away this rem instruction.
1016       if (SimplifyDemandedInstructionBits(I))
1017         return &I;
1018     }
1019   }
1020
1021   return 0;
1022 }
1023
1024 Instruction *InstCombiner::visitURem(BinaryOperator &I) {
1025   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1026
1027   if (Value *V = SimplifyURemInst(Op0, Op1, TD))
1028     return ReplaceInstUsesWith(I, V);
1029
1030   if (Instruction *common = commonIRemTransforms(I))
1031     return common;
1032
1033   // (zext A) urem (zext B) --> zext (A urem B)
1034   if (ZExtInst *ZOp0 = dyn_cast<ZExtInst>(Op0))
1035     if (Value *ZOp1 = dyn_castZExtVal(Op1, ZOp0->getSrcTy()))
1036       return new ZExtInst(Builder->CreateURem(ZOp0->getOperand(0), ZOp1),
1037                           I.getType());
1038
1039   // X urem Y -> X and Y-1, where Y is a power of 2,
1040   if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/true)) {
1041     Constant *N1 = Constant::getAllOnesValue(I.getType());
1042     Value *Add = Builder->CreateAdd(Op1, N1);
1043     return BinaryOperator::CreateAnd(Op0, Add);
1044   }
1045
1046   return 0;
1047 }
1048
1049 Instruction *InstCombiner::visitSRem(BinaryOperator &I) {
1050   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1051
1052   if (Value *V = SimplifySRemInst(Op0, Op1, TD))
1053     return ReplaceInstUsesWith(I, V);
1054
1055   // Handle the integer rem common cases
1056   if (Instruction *Common = commonIRemTransforms(I))
1057     return Common;
1058
1059   if (Value *RHSNeg = dyn_castNegVal(Op1))
1060     if (!isa<Constant>(RHSNeg) ||
1061         (isa<ConstantInt>(RHSNeg) &&
1062          cast<ConstantInt>(RHSNeg)->getValue().isStrictlyPositive())) {
1063       // X % -Y -> X % Y
1064       Worklist.AddValue(I.getOperand(1));
1065       I.setOperand(1, RHSNeg);
1066       return &I;
1067     }
1068
1069   // If the sign bits of both operands are zero (i.e. we can prove they are
1070   // unsigned inputs), turn this into a urem.
1071   if (I.getType()->isIntegerTy()) {
1072     APInt Mask(APInt::getSignBit(I.getType()->getPrimitiveSizeInBits()));
1073     if (MaskedValueIsZero(Op1, Mask) && MaskedValueIsZero(Op0, Mask)) {
1074       // X srem Y -> X urem Y, iff X and Y don't have sign bit set
1075       return BinaryOperator::CreateURem(Op0, Op1, I.getName());
1076     }
1077   }
1078
1079   // If it's a constant vector, flip any negative values positive.
1080   if (isa<ConstantVector>(Op1) || isa<ConstantDataVector>(Op1)) {
1081     Constant *C = cast<Constant>(Op1);
1082     unsigned VWidth = C->getType()->getVectorNumElements();
1083
1084     bool hasNegative = false;
1085     bool hasMissing = false;
1086     for (unsigned i = 0; i != VWidth; ++i) {
1087       Constant *Elt = C->getAggregateElement(i);
1088       if (Elt == 0) {
1089         hasMissing = true;
1090         break;
1091       }
1092
1093       if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elt))
1094         if (RHS->isNegative())
1095           hasNegative = true;
1096     }
1097
1098     if (hasNegative && !hasMissing) {
1099       SmallVector<Constant *, 16> Elts(VWidth);
1100       for (unsigned i = 0; i != VWidth; ++i) {
1101         Elts[i] = C->getAggregateElement(i);  // Handle undef, etc.
1102         if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elts[i])) {
1103           if (RHS->isNegative())
1104             Elts[i] = cast<ConstantInt>(ConstantExpr::getNeg(RHS));
1105         }
1106       }
1107
1108       Constant *NewRHSV = ConstantVector::get(Elts);
1109       if (NewRHSV != C) {  // Don't loop on -MININT
1110         Worklist.AddValue(I.getOperand(1));
1111         I.setOperand(1, NewRHSV);
1112         return &I;
1113       }
1114     }
1115   }
1116
1117   return 0;
1118 }
1119
1120 Instruction *InstCombiner::visitFRem(BinaryOperator &I) {
1121   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1122
1123   if (Value *V = SimplifyFRemInst(Op0, Op1, TD))
1124     return ReplaceInstUsesWith(I, V);
1125
1126   // Handle cases involving: rem X, (select Cond, Y, Z)
1127   if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
1128     return &I;
1129
1130   return 0;
1131 }