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 "InstCombineInternal.h"
16 #include "llvm/Analysis/InstructionSimplify.h"
17 #include "llvm/IR/IntrinsicInst.h"
18 #include "llvm/IR/PatternMatch.h"
19 using namespace llvm;
20 using namespace PatternMatch;
21 
22 #define DEBUG_TYPE "instcombine"
23 
24 
25 /// The specific integer value is used in a context where it is known to be
26 /// non-zero.  If this allows us to simplify the computation, do so and return
27 /// the new operand, otherwise return null.
28 static Value *simplifyValueKnownNonZero(Value *V, InstCombiner &IC,
29                                         Instruction &CxtI) {
30   // If V has multiple uses, then we would have to do more analysis to determine
31   // if this is safe.  For example, the use could be in dynamically unreached
32   // code.
33   if (!V->hasOneUse()) return nullptr;
34 
35   bool MadeChange = false;
36 
37   // ((1 << A) >>u B) --> (1 << (A-B))
38   // Because V cannot be zero, we know that B is less than A.
39   Value *A = nullptr, *B = nullptr, *One = nullptr;
40   if (match(V, m_LShr(m_OneUse(m_Shl(m_Value(One), m_Value(A))), m_Value(B))) &&
41       match(One, m_One())) {
42     A = IC.Builder->CreateSub(A, B);
43     return IC.Builder->CreateShl(One, A);
44   }
45 
46   // (PowerOfTwo >>u B) --> isExact since shifting out the result would make it
47   // inexact.  Similarly for <<.
48   BinaryOperator *I = dyn_cast<BinaryOperator>(V);
49   if (I && I->isLogicalShift() &&
50       isKnownToBeAPowerOfTwo(I->getOperand(0), IC.getDataLayout(), false, 0,
51                              &IC.getAssumptionCache(), &CxtI,
52                              &IC.getDominatorTree())) {
53     // We know that this is an exact/nuw shift and that the input is a
54     // non-zero context as well.
55     if (Value *V2 = simplifyValueKnownNonZero(I->getOperand(0), IC, CxtI)) {
56       I->setOperand(0, V2);
57       MadeChange = true;
58     }
59 
60     if (I->getOpcode() == Instruction::LShr && !I->isExact()) {
61       I->setIsExact();
62       MadeChange = true;
63     }
64 
65     if (I->getOpcode() == Instruction::Shl && !I->hasNoUnsignedWrap()) {
66       I->setHasNoUnsignedWrap();
67       MadeChange = true;
68     }
69   }
70 
71   // TODO: Lots more we could do here:
72   //    If V is a phi node, we can call this on each of its operands.
73   //    "select cond, X, 0" can simplify to "X".
74 
75   return MadeChange ? V : nullptr;
76 }
77 
78 
79 /// True if the multiply can not be expressed in an int this size.
80 static bool MultiplyOverflows(const APInt &C1, const APInt &C2, APInt &Product,
81                               bool IsSigned) {
82   bool Overflow;
83   if (IsSigned)
84     Product = C1.smul_ov(C2, Overflow);
85   else
86     Product = C1.umul_ov(C2, Overflow);
87 
88   return Overflow;
89 }
90 
91 /// \brief True if C2 is a multiple of C1. Quotient contains C2/C1.
92 static bool IsMultiple(const APInt &C1, const APInt &C2, APInt &Quotient,
93                        bool IsSigned) {
94   assert(C1.getBitWidth() == C2.getBitWidth() &&
95          "Inconsistent width of constants!");
96 
97   // Bail if we will divide by zero.
98   if (C2.isMinValue())
99     return false;
100 
101   // Bail if we would divide INT_MIN by -1.
102   if (IsSigned && C1.isMinSignedValue() && C2.isAllOnesValue())
103     return false;
104 
105   APInt Remainder(C1.getBitWidth(), /*Val=*/0ULL, IsSigned);
106   if (IsSigned)
107     APInt::sdivrem(C1, C2, Quotient, Remainder);
108   else
109     APInt::udivrem(C1, C2, Quotient, Remainder);
110 
111   return Remainder.isMinValue();
112 }
113 
114 /// \brief A helper routine of InstCombiner::visitMul().
115 ///
116 /// If C is a vector of known powers of 2, then this function returns
117 /// a new vector obtained from C replacing each element with its logBase2.
118 /// Return a null pointer otherwise.
119 static Constant *getLogBase2Vector(ConstantDataVector *CV) {
120   const APInt *IVal;
121   SmallVector<Constant *, 4> Elts;
122 
123   for (unsigned I = 0, E = CV->getNumElements(); I != E; ++I) {
124     Constant *Elt = CV->getElementAsConstant(I);
125     if (!match(Elt, m_APInt(IVal)) || !IVal->isPowerOf2())
126       return nullptr;
127     Elts.push_back(ConstantInt::get(Elt->getType(), IVal->logBase2()));
128   }
129 
130   return ConstantVector::get(Elts);
131 }
132 
133 /// \brief Return true if we can prove that:
134 ///    (mul LHS, RHS)  === (mul nsw LHS, RHS)
135 bool InstCombiner::WillNotOverflowSignedMul(Value *LHS, Value *RHS,
136                                             Instruction &CxtI) {
137   // Multiplying n * m significant bits yields a result of n + m significant
138   // bits. If the total number of significant bits does not exceed the
139   // result bit width (minus 1), there is no overflow.
140   // This means if we have enough leading sign bits in the operands
141   // we can guarantee that the result does not overflow.
142   // Ref: "Hacker's Delight" by Henry Warren
143   unsigned BitWidth = LHS->getType()->getScalarSizeInBits();
144 
145   // Note that underestimating the number of sign bits gives a more
146   // conservative answer.
147   unsigned SignBits =
148       ComputeNumSignBits(LHS, 0, &CxtI) + ComputeNumSignBits(RHS, 0, &CxtI);
149 
150   // First handle the easy case: if we have enough sign bits there's
151   // definitely no overflow.
152   if (SignBits > BitWidth + 1)
153     return true;
154 
155   // There are two ambiguous cases where there can be no overflow:
156   //   SignBits == BitWidth + 1    and
157   //   SignBits == BitWidth
158   // The second case is difficult to check, therefore we only handle the
159   // first case.
160   if (SignBits == BitWidth + 1) {
161     // It overflows only when both arguments are negative and the true
162     // product is exactly the minimum negative number.
163     // E.g. mul i16 with 17 sign bits: 0xff00 * 0xff80 = 0x8000
164     // For simplicity we just check if at least one side is not negative.
165     bool LHSNonNegative, LHSNegative;
166     bool RHSNonNegative, RHSNegative;
167     ComputeSignBit(LHS, LHSNonNegative, LHSNegative, /*Depth=*/0, &CxtI);
168     ComputeSignBit(RHS, RHSNonNegative, RHSNegative, /*Depth=*/0, &CxtI);
169     if (LHSNonNegative || RHSNonNegative)
170       return true;
171   }
172   return false;
173 }
174 
175 Instruction *InstCombiner::visitMul(BinaryOperator &I) {
176   bool Changed = SimplifyAssociativeOrCommutative(I);
177   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
178 
179   if (Value *V = SimplifyVectorOp(I))
180     return replaceInstUsesWith(I, V);
181 
182   if (Value *V = SimplifyMulInst(Op0, Op1, DL, &TLI, &DT, &AC))
183     return replaceInstUsesWith(I, V);
184 
185   if (Value *V = SimplifyUsingDistributiveLaws(I))
186     return replaceInstUsesWith(I, V);
187 
188   // X * -1 == 0 - X
189   if (match(Op1, m_AllOnes())) {
190     BinaryOperator *BO = BinaryOperator::CreateNeg(Op0, I.getName());
191     if (I.hasNoSignedWrap())
192       BO->setHasNoSignedWrap();
193     return BO;
194   }
195 
196   // Also allow combining multiply instructions on vectors.
197   {
198     Value *NewOp;
199     Constant *C1, *C2;
200     const APInt *IVal;
201     if (match(&I, m_Mul(m_Shl(m_Value(NewOp), m_Constant(C2)),
202                         m_Constant(C1))) &&
203         match(C1, m_APInt(IVal))) {
204       // ((X << C2)*C1) == (X * (C1 << C2))
205       Constant *Shl = ConstantExpr::getShl(C1, C2);
206       BinaryOperator *Mul = cast<BinaryOperator>(I.getOperand(0));
207       BinaryOperator *BO = BinaryOperator::CreateMul(NewOp, Shl);
208       if (I.hasNoUnsignedWrap() && Mul->hasNoUnsignedWrap())
209         BO->setHasNoUnsignedWrap();
210       if (I.hasNoSignedWrap() && Mul->hasNoSignedWrap() &&
211           Shl->isNotMinSignedValue())
212         BO->setHasNoSignedWrap();
213       return BO;
214     }
215 
216     if (match(&I, m_Mul(m_Value(NewOp), m_Constant(C1)))) {
217       Constant *NewCst = nullptr;
218       if (match(C1, m_APInt(IVal)) && IVal->isPowerOf2())
219         // Replace X*(2^C) with X << C, where C is either a scalar or a splat.
220         NewCst = ConstantInt::get(NewOp->getType(), IVal->logBase2());
221       else if (ConstantDataVector *CV = dyn_cast<ConstantDataVector>(C1))
222         // Replace X*(2^C) with X << C, where C is a vector of known
223         // constant powers of 2.
224         NewCst = getLogBase2Vector(CV);
225 
226       if (NewCst) {
227         unsigned Width = NewCst->getType()->getPrimitiveSizeInBits();
228         BinaryOperator *Shl = BinaryOperator::CreateShl(NewOp, NewCst);
229 
230         if (I.hasNoUnsignedWrap())
231           Shl->setHasNoUnsignedWrap();
232         if (I.hasNoSignedWrap()) {
233           uint64_t V;
234           if (match(NewCst, m_ConstantInt(V)) && V != Width - 1)
235             Shl->setHasNoSignedWrap();
236         }
237 
238         return Shl;
239       }
240     }
241   }
242 
243   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
244     // (Y - X) * (-(2**n)) -> (X - Y) * (2**n), for positive nonzero n
245     // (Y + const) * (-(2**n)) -> (-constY) * (2**n), for positive nonzero n
246     // The "* (2**n)" thus becomes a potential shifting opportunity.
247     {
248       const APInt &   Val = CI->getValue();
249       const APInt &PosVal = Val.abs();
250       if (Val.isNegative() && PosVal.isPowerOf2()) {
251         Value *X = nullptr, *Y = nullptr;
252         if (Op0->hasOneUse()) {
253           ConstantInt *C1;
254           Value *Sub = nullptr;
255           if (match(Op0, m_Sub(m_Value(Y), m_Value(X))))
256             Sub = Builder->CreateSub(X, Y, "suba");
257           else if (match(Op0, m_Add(m_Value(Y), m_ConstantInt(C1))))
258             Sub = Builder->CreateSub(Builder->CreateNeg(C1), Y, "subc");
259           if (Sub)
260             return
261               BinaryOperator::CreateMul(Sub,
262                                         ConstantInt::get(Y->getType(), PosVal));
263         }
264       }
265     }
266   }
267 
268   // Simplify mul instructions with a constant RHS.
269   if (isa<Constant>(Op1)) {
270     if (Instruction *FoldedMul = foldOpWithConstantIntoOperand(I))
271       return FoldedMul;
272 
273     // Canonicalize (X+C1)*CI -> X*CI+C1*CI.
274     {
275       Value *X;
276       Constant *C1;
277       if (match(Op0, m_OneUse(m_Add(m_Value(X), m_Constant(C1))))) {
278         Value *Mul = Builder->CreateMul(C1, Op1);
279         // Only go forward with the transform if C1*CI simplifies to a tidier
280         // constant.
281         if (!match(Mul, m_Mul(m_Value(), m_Value())))
282           return BinaryOperator::CreateAdd(Builder->CreateMul(X, Op1), Mul);
283       }
284     }
285   }
286 
287   if (Value *Op0v = dyn_castNegVal(Op0)) {   // -X * -Y = X*Y
288     if (Value *Op1v = dyn_castNegVal(Op1)) {
289       BinaryOperator *BO = BinaryOperator::CreateMul(Op0v, Op1v);
290       if (I.hasNoSignedWrap() &&
291           match(Op0, m_NSWSub(m_Value(), m_Value())) &&
292           match(Op1, m_NSWSub(m_Value(), m_Value())))
293         BO->setHasNoSignedWrap();
294       return BO;
295     }
296   }
297 
298   // (X / Y) *  Y = X - (X % Y)
299   // (X / Y) * -Y = (X % Y) - X
300   {
301     Value *Y = Op1;
302     BinaryOperator *Div = dyn_cast<BinaryOperator>(Op0);
303     if (!Div || (Div->getOpcode() != Instruction::UDiv &&
304                  Div->getOpcode() != Instruction::SDiv)) {
305       Y = Op0;
306       Div = dyn_cast<BinaryOperator>(Op1);
307     }
308     Value *Neg = dyn_castNegVal(Y);
309     if (Div && Div->hasOneUse() &&
310         (Div->getOperand(1) == Y || Div->getOperand(1) == Neg) &&
311         (Div->getOpcode() == Instruction::UDiv ||
312          Div->getOpcode() == Instruction::SDiv)) {
313       Value *X = Div->getOperand(0), *DivOp1 = Div->getOperand(1);
314 
315       // If the division is exact, X % Y is zero, so we end up with X or -X.
316       if (Div->isExact()) {
317         if (DivOp1 == Y)
318           return replaceInstUsesWith(I, X);
319         return BinaryOperator::CreateNeg(X);
320       }
321 
322       auto RemOpc = Div->getOpcode() == Instruction::UDiv ? Instruction::URem
323                                                           : Instruction::SRem;
324       Value *Rem = Builder->CreateBinOp(RemOpc, X, DivOp1);
325       if (DivOp1 == Y)
326         return BinaryOperator::CreateSub(X, Rem);
327       return BinaryOperator::CreateSub(Rem, X);
328     }
329   }
330 
331   /// i1 mul -> i1 and.
332   if (I.getType()->getScalarType()->isIntegerTy(1))
333     return BinaryOperator::CreateAnd(Op0, Op1);
334 
335   // X*(1 << Y) --> X << Y
336   // (1 << Y)*X --> X << Y
337   {
338     Value *Y;
339     BinaryOperator *BO = nullptr;
340     bool ShlNSW = false;
341     if (match(Op0, m_Shl(m_One(), m_Value(Y)))) {
342       BO = BinaryOperator::CreateShl(Op1, Y);
343       ShlNSW = cast<ShlOperator>(Op0)->hasNoSignedWrap();
344     } else if (match(Op1, m_Shl(m_One(), m_Value(Y)))) {
345       BO = BinaryOperator::CreateShl(Op0, Y);
346       ShlNSW = cast<ShlOperator>(Op1)->hasNoSignedWrap();
347     }
348     if (BO) {
349       if (I.hasNoUnsignedWrap())
350         BO->setHasNoUnsignedWrap();
351       if (I.hasNoSignedWrap() && ShlNSW)
352         BO->setHasNoSignedWrap();
353       return BO;
354     }
355   }
356 
357   // If one of the operands of the multiply is a cast from a boolean value, then
358   // we know the bool is either zero or one, so this is a 'masking' multiply.
359   //   X * Y (where Y is 0 or 1) -> X & (0-Y)
360   if (!I.getType()->isVectorTy()) {
361     // -2 is "-1 << 1" so it is all bits set except the low one.
362     APInt Negative2(I.getType()->getPrimitiveSizeInBits(), (uint64_t)-2, true);
363 
364     Value *BoolCast = nullptr, *OtherOp = nullptr;
365     if (MaskedValueIsZero(Op0, Negative2, 0, &I)) {
366       BoolCast = Op0;
367       OtherOp = Op1;
368     } else if (MaskedValueIsZero(Op1, Negative2, 0, &I)) {
369       BoolCast = Op1;
370       OtherOp = Op0;
371     }
372 
373     if (BoolCast) {
374       Value *V = Builder->CreateSub(Constant::getNullValue(I.getType()),
375                                     BoolCast);
376       return BinaryOperator::CreateAnd(V, OtherOp);
377     }
378   }
379 
380   // Check for (mul (sext x), y), see if we can merge this into an
381   // integer mul followed by a sext.
382   if (SExtInst *Op0Conv = dyn_cast<SExtInst>(Op0)) {
383     // (mul (sext x), cst) --> (sext (mul x, cst'))
384     if (ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
385       if (Op0Conv->hasOneUse()) {
386         Constant *CI =
387             ConstantExpr::getTrunc(Op1C, Op0Conv->getOperand(0)->getType());
388         if (ConstantExpr::getSExt(CI, I.getType()) == Op1C &&
389             WillNotOverflowSignedMul(Op0Conv->getOperand(0), CI, I)) {
390           // Insert the new, smaller mul.
391           Value *NewMul =
392               Builder->CreateNSWMul(Op0Conv->getOperand(0), CI, "mulconv");
393           return new SExtInst(NewMul, I.getType());
394         }
395       }
396     }
397 
398     // (mul (sext x), (sext y)) --> (sext (mul int x, y))
399     if (SExtInst *Op1Conv = dyn_cast<SExtInst>(Op1)) {
400       // Only do this if x/y have the same type, if at last one of them has a
401       // single use (so we don't increase the number of sexts), and if the
402       // integer mul will not overflow.
403       if (Op0Conv->getOperand(0)->getType() ==
404               Op1Conv->getOperand(0)->getType() &&
405           (Op0Conv->hasOneUse() || Op1Conv->hasOneUse()) &&
406           WillNotOverflowSignedMul(Op0Conv->getOperand(0),
407                                    Op1Conv->getOperand(0), I)) {
408         // Insert the new integer mul.
409         Value *NewMul = Builder->CreateNSWMul(
410             Op0Conv->getOperand(0), Op1Conv->getOperand(0), "mulconv");
411         return new SExtInst(NewMul, I.getType());
412       }
413     }
414   }
415 
416   // Check for (mul (zext x), y), see if we can merge this into an
417   // integer mul followed by a zext.
418   if (auto *Op0Conv = dyn_cast<ZExtInst>(Op0)) {
419     // (mul (zext x), cst) --> (zext (mul x, cst'))
420     if (ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
421       if (Op0Conv->hasOneUse()) {
422         Constant *CI =
423             ConstantExpr::getTrunc(Op1C, Op0Conv->getOperand(0)->getType());
424         if (ConstantExpr::getZExt(CI, I.getType()) == Op1C &&
425             computeOverflowForUnsignedMul(Op0Conv->getOperand(0), CI, &I) ==
426                 OverflowResult::NeverOverflows) {
427           // Insert the new, smaller mul.
428           Value *NewMul =
429               Builder->CreateNUWMul(Op0Conv->getOperand(0), CI, "mulconv");
430           return new ZExtInst(NewMul, I.getType());
431         }
432       }
433     }
434 
435     // (mul (zext x), (zext y)) --> (zext (mul int x, y))
436     if (auto *Op1Conv = dyn_cast<ZExtInst>(Op1)) {
437       // Only do this if x/y have the same type, if at last one of them has a
438       // single use (so we don't increase the number of zexts), and if the
439       // integer mul will not overflow.
440       if (Op0Conv->getOperand(0)->getType() ==
441               Op1Conv->getOperand(0)->getType() &&
442           (Op0Conv->hasOneUse() || Op1Conv->hasOneUse()) &&
443           computeOverflowForUnsignedMul(Op0Conv->getOperand(0),
444                                         Op1Conv->getOperand(0),
445                                         &I) == OverflowResult::NeverOverflows) {
446         // Insert the new integer mul.
447         Value *NewMul = Builder->CreateNUWMul(
448             Op0Conv->getOperand(0), Op1Conv->getOperand(0), "mulconv");
449         return new ZExtInst(NewMul, I.getType());
450       }
451     }
452   }
453 
454   if (!I.hasNoSignedWrap() && WillNotOverflowSignedMul(Op0, Op1, I)) {
455     Changed = true;
456     I.setHasNoSignedWrap(true);
457   }
458 
459   if (!I.hasNoUnsignedWrap() &&
460       computeOverflowForUnsignedMul(Op0, Op1, &I) ==
461           OverflowResult::NeverOverflows) {
462     Changed = true;
463     I.setHasNoUnsignedWrap(true);
464   }
465 
466   return Changed ? &I : nullptr;
467 }
468 
469 /// Detect pattern log2(Y * 0.5) with corresponding fast math flags.
470 static void detectLog2OfHalf(Value *&Op, Value *&Y, IntrinsicInst *&Log2) {
471   if (!Op->hasOneUse())
472     return;
473 
474   IntrinsicInst *II = dyn_cast<IntrinsicInst>(Op);
475   if (!II)
476     return;
477   if (II->getIntrinsicID() != Intrinsic::log2 || !II->hasUnsafeAlgebra())
478     return;
479   Log2 = II;
480 
481   Value *OpLog2Of = II->getArgOperand(0);
482   if (!OpLog2Of->hasOneUse())
483     return;
484 
485   Instruction *I = dyn_cast<Instruction>(OpLog2Of);
486   if (!I)
487     return;
488   if (I->getOpcode() != Instruction::FMul || !I->hasUnsafeAlgebra())
489     return;
490 
491   if (match(I->getOperand(0), m_SpecificFP(0.5)))
492     Y = I->getOperand(1);
493   else if (match(I->getOperand(1), m_SpecificFP(0.5)))
494     Y = I->getOperand(0);
495 }
496 
497 static bool isFiniteNonZeroFp(Constant *C) {
498   if (C->getType()->isVectorTy()) {
499     for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E;
500          ++I) {
501       ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(C->getAggregateElement(I));
502       if (!CFP || !CFP->getValueAPF().isFiniteNonZero())
503         return false;
504     }
505     return true;
506   }
507 
508   return isa<ConstantFP>(C) &&
509          cast<ConstantFP>(C)->getValueAPF().isFiniteNonZero();
510 }
511 
512 static bool isNormalFp(Constant *C) {
513   if (C->getType()->isVectorTy()) {
514     for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E;
515          ++I) {
516       ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(C->getAggregateElement(I));
517       if (!CFP || !CFP->getValueAPF().isNormal())
518         return false;
519     }
520     return true;
521   }
522 
523   return isa<ConstantFP>(C) && cast<ConstantFP>(C)->getValueAPF().isNormal();
524 }
525 
526 /// Helper function of InstCombiner::visitFMul(BinaryOperator(). It returns
527 /// true iff the given value is FMul or FDiv with one and only one operand
528 /// being a normal constant (i.e. not Zero/NaN/Infinity).
529 static bool isFMulOrFDivWithConstant(Value *V) {
530   Instruction *I = dyn_cast<Instruction>(V);
531   if (!I || (I->getOpcode() != Instruction::FMul &&
532              I->getOpcode() != Instruction::FDiv))
533     return false;
534 
535   Constant *C0 = dyn_cast<Constant>(I->getOperand(0));
536   Constant *C1 = dyn_cast<Constant>(I->getOperand(1));
537 
538   if (C0 && C1)
539     return false;
540 
541   return (C0 && isFiniteNonZeroFp(C0)) || (C1 && isFiniteNonZeroFp(C1));
542 }
543 
544 /// foldFMulConst() is a helper routine of InstCombiner::visitFMul().
545 /// The input \p FMulOrDiv is a FMul/FDiv with one and only one operand
546 /// being a constant (i.e. isFMulOrFDivWithConstant(FMulOrDiv) == true).
547 /// This function is to simplify "FMulOrDiv * C" and returns the
548 /// resulting expression. Note that this function could return NULL in
549 /// case the constants cannot be folded into a normal floating-point.
550 ///
551 Value *InstCombiner::foldFMulConst(Instruction *FMulOrDiv, Constant *C,
552                                    Instruction *InsertBefore) {
553   assert(isFMulOrFDivWithConstant(FMulOrDiv) && "V is invalid");
554 
555   Value *Opnd0 = FMulOrDiv->getOperand(0);
556   Value *Opnd1 = FMulOrDiv->getOperand(1);
557 
558   Constant *C0 = dyn_cast<Constant>(Opnd0);
559   Constant *C1 = dyn_cast<Constant>(Opnd1);
560 
561   BinaryOperator *R = nullptr;
562 
563   // (X * C0) * C => X * (C0*C)
564   if (FMulOrDiv->getOpcode() == Instruction::FMul) {
565     Constant *F = ConstantExpr::getFMul(C1 ? C1 : C0, C);
566     if (isNormalFp(F))
567       R = BinaryOperator::CreateFMul(C1 ? Opnd0 : Opnd1, F);
568   } else {
569     if (C0) {
570       // (C0 / X) * C => (C0 * C) / X
571       if (FMulOrDiv->hasOneUse()) {
572         // It would otherwise introduce another div.
573         Constant *F = ConstantExpr::getFMul(C0, C);
574         if (isNormalFp(F))
575           R = BinaryOperator::CreateFDiv(F, Opnd1);
576       }
577     } else {
578       // (X / C1) * C => X * (C/C1) if C/C1 is not a denormal
579       Constant *F = ConstantExpr::getFDiv(C, C1);
580       if (isNormalFp(F)) {
581         R = BinaryOperator::CreateFMul(Opnd0, F);
582       } else {
583         // (X / C1) * C => X / (C1/C)
584         Constant *F = ConstantExpr::getFDiv(C1, C);
585         if (isNormalFp(F))
586           R = BinaryOperator::CreateFDiv(Opnd0, F);
587       }
588     }
589   }
590 
591   if (R) {
592     R->setHasUnsafeAlgebra(true);
593     InsertNewInstWith(R, *InsertBefore);
594   }
595 
596   return R;
597 }
598 
599 Instruction *InstCombiner::visitFMul(BinaryOperator &I) {
600   bool Changed = SimplifyAssociativeOrCommutative(I);
601   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
602 
603   if (Value *V = SimplifyVectorOp(I))
604     return replaceInstUsesWith(I, V);
605 
606   if (isa<Constant>(Op0))
607     std::swap(Op0, Op1);
608 
609   if (Value *V =
610           SimplifyFMulInst(Op0, Op1, I.getFastMathFlags(), DL, &TLI, &DT, &AC))
611     return replaceInstUsesWith(I, V);
612 
613   bool AllowReassociate = I.hasUnsafeAlgebra();
614 
615   // Simplify mul instructions with a constant RHS.
616   if (isa<Constant>(Op1)) {
617     if (Instruction *FoldedMul = foldOpWithConstantIntoOperand(I))
618       return FoldedMul;
619 
620     // (fmul X, -1.0) --> (fsub -0.0, X)
621     if (match(Op1, m_SpecificFP(-1.0))) {
622       Constant *NegZero = ConstantFP::getNegativeZero(Op1->getType());
623       Instruction *RI = BinaryOperator::CreateFSub(NegZero, Op0);
624       RI->copyFastMathFlags(&I);
625       return RI;
626     }
627 
628     Constant *C = cast<Constant>(Op1);
629     if (AllowReassociate && isFiniteNonZeroFp(C)) {
630       // Let MDC denote an expression in one of these forms:
631       // X * C, C/X, X/C, where C is a constant.
632       //
633       // Try to simplify "MDC * Constant"
634       if (isFMulOrFDivWithConstant(Op0))
635         if (Value *V = foldFMulConst(cast<Instruction>(Op0), C, &I))
636           return replaceInstUsesWith(I, V);
637 
638       // (MDC +/- C1) * C => (MDC * C) +/- (C1 * C)
639       Instruction *FAddSub = dyn_cast<Instruction>(Op0);
640       if (FAddSub &&
641           (FAddSub->getOpcode() == Instruction::FAdd ||
642            FAddSub->getOpcode() == Instruction::FSub)) {
643         Value *Opnd0 = FAddSub->getOperand(0);
644         Value *Opnd1 = FAddSub->getOperand(1);
645         Constant *C0 = dyn_cast<Constant>(Opnd0);
646         Constant *C1 = dyn_cast<Constant>(Opnd1);
647         bool Swap = false;
648         if (C0) {
649           std::swap(C0, C1);
650           std::swap(Opnd0, Opnd1);
651           Swap = true;
652         }
653 
654         if (C1 && isFiniteNonZeroFp(C1) && isFMulOrFDivWithConstant(Opnd0)) {
655           Value *M1 = ConstantExpr::getFMul(C1, C);
656           Value *M0 = isNormalFp(cast<Constant>(M1)) ?
657                       foldFMulConst(cast<Instruction>(Opnd0), C, &I) :
658                       nullptr;
659           if (M0 && M1) {
660             if (Swap && FAddSub->getOpcode() == Instruction::FSub)
661               std::swap(M0, M1);
662 
663             Instruction *RI = (FAddSub->getOpcode() == Instruction::FAdd)
664                                   ? BinaryOperator::CreateFAdd(M0, M1)
665                                   : BinaryOperator::CreateFSub(M0, M1);
666             RI->copyFastMathFlags(&I);
667             return RI;
668           }
669         }
670       }
671     }
672   }
673 
674   if (Op0 == Op1) {
675     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Op0)) {
676       // sqrt(X) * sqrt(X) -> X
677       if (AllowReassociate && II->getIntrinsicID() == Intrinsic::sqrt)
678         return replaceInstUsesWith(I, II->getOperand(0));
679 
680       // fabs(X) * fabs(X) -> X * X
681       if (II->getIntrinsicID() == Intrinsic::fabs) {
682         Instruction *FMulVal = BinaryOperator::CreateFMul(II->getOperand(0),
683                                                           II->getOperand(0),
684                                                           I.getName());
685         FMulVal->copyFastMathFlags(&I);
686         return FMulVal;
687       }
688     }
689   }
690 
691   // Under unsafe algebra do:
692   // X * log2(0.5*Y) = X*log2(Y) - X
693   if (AllowReassociate) {
694     Value *OpX = nullptr;
695     Value *OpY = nullptr;
696     IntrinsicInst *Log2;
697     detectLog2OfHalf(Op0, OpY, Log2);
698     if (OpY) {
699       OpX = Op1;
700     } else {
701       detectLog2OfHalf(Op1, OpY, Log2);
702       if (OpY) {
703         OpX = Op0;
704       }
705     }
706     // if pattern detected emit alternate sequence
707     if (OpX && OpY) {
708       BuilderTy::FastMathFlagGuard Guard(*Builder);
709       Builder->setFastMathFlags(Log2->getFastMathFlags());
710       Log2->setArgOperand(0, OpY);
711       Value *FMulVal = Builder->CreateFMul(OpX, Log2);
712       Value *FSub = Builder->CreateFSub(FMulVal, OpX);
713       FSub->takeName(&I);
714       return replaceInstUsesWith(I, FSub);
715     }
716   }
717 
718   // Handle symmetric situation in a 2-iteration loop
719   Value *Opnd0 = Op0;
720   Value *Opnd1 = Op1;
721   for (int i = 0; i < 2; i++) {
722     bool IgnoreZeroSign = I.hasNoSignedZeros();
723     if (BinaryOperator::isFNeg(Opnd0, IgnoreZeroSign)) {
724       BuilderTy::FastMathFlagGuard Guard(*Builder);
725       Builder->setFastMathFlags(I.getFastMathFlags());
726 
727       Value *N0 = dyn_castFNegVal(Opnd0, IgnoreZeroSign);
728       Value *N1 = dyn_castFNegVal(Opnd1, IgnoreZeroSign);
729 
730       // -X * -Y => X*Y
731       if (N1) {
732         Value *FMul = Builder->CreateFMul(N0, N1);
733         FMul->takeName(&I);
734         return replaceInstUsesWith(I, FMul);
735       }
736 
737       if (Opnd0->hasOneUse()) {
738         // -X * Y => -(X*Y) (Promote negation as high as possible)
739         Value *T = Builder->CreateFMul(N0, Opnd1);
740         Value *Neg = Builder->CreateFNeg(T);
741         Neg->takeName(&I);
742         return replaceInstUsesWith(I, Neg);
743       }
744     }
745 
746     // (X*Y) * X => (X*X) * Y where Y != X
747     //  The purpose is two-fold:
748     //   1) to form a power expression (of X).
749     //   2) potentially shorten the critical path: After transformation, the
750     //  latency of the instruction Y is amortized by the expression of X*X,
751     //  and therefore Y is in a "less critical" position compared to what it
752     //  was before the transformation.
753     //
754     if (AllowReassociate) {
755       Value *Opnd0_0, *Opnd0_1;
756       if (Opnd0->hasOneUse() &&
757           match(Opnd0, m_FMul(m_Value(Opnd0_0), m_Value(Opnd0_1)))) {
758         Value *Y = nullptr;
759         if (Opnd0_0 == Opnd1 && Opnd0_1 != Opnd1)
760           Y = Opnd0_1;
761         else if (Opnd0_1 == Opnd1 && Opnd0_0 != Opnd1)
762           Y = Opnd0_0;
763 
764         if (Y) {
765           BuilderTy::FastMathFlagGuard Guard(*Builder);
766           Builder->setFastMathFlags(I.getFastMathFlags());
767           Value *T = Builder->CreateFMul(Opnd1, Opnd1);
768           Value *R = Builder->CreateFMul(T, Y);
769           R->takeName(&I);
770           return replaceInstUsesWith(I, R);
771         }
772       }
773     }
774 
775     if (!isa<Constant>(Op1))
776       std::swap(Opnd0, Opnd1);
777     else
778       break;
779   }
780 
781   return Changed ? &I : nullptr;
782 }
783 
784 /// Try to fold a divide or remainder of a select instruction.
785 bool InstCombiner::SimplifyDivRemOfSelect(BinaryOperator &I) {
786   SelectInst *SI = cast<SelectInst>(I.getOperand(1));
787 
788   // div/rem X, (Cond ? 0 : Y) -> div/rem X, Y
789   int NonNullOperand = -1;
790   if (Constant *ST = dyn_cast<Constant>(SI->getOperand(1)))
791     if (ST->isNullValue())
792       NonNullOperand = 2;
793   // div/rem X, (Cond ? Y : 0) -> div/rem X, Y
794   if (Constant *ST = dyn_cast<Constant>(SI->getOperand(2)))
795     if (ST->isNullValue())
796       NonNullOperand = 1;
797 
798   if (NonNullOperand == -1)
799     return false;
800 
801   Value *SelectCond = SI->getOperand(0);
802 
803   // Change the div/rem to use 'Y' instead of the select.
804   I.setOperand(1, SI->getOperand(NonNullOperand));
805 
806   // Okay, we know we replace the operand of the div/rem with 'Y' with no
807   // problem.  However, the select, or the condition of the select may have
808   // multiple uses.  Based on our knowledge that the operand must be non-zero,
809   // propagate the known value for the select into other uses of it, and
810   // propagate a known value of the condition into its other users.
811 
812   // If the select and condition only have a single use, don't bother with this,
813   // early exit.
814   if (SI->use_empty() && SelectCond->hasOneUse())
815     return true;
816 
817   // Scan the current block backward, looking for other uses of SI.
818   BasicBlock::iterator BBI = I.getIterator(), BBFront = I.getParent()->begin();
819 
820   while (BBI != BBFront) {
821     --BBI;
822     // If we found a call to a function, we can't assume it will return, so
823     // information from below it cannot be propagated above it.
824     if (isa<CallInst>(BBI) && !isa<IntrinsicInst>(BBI))
825       break;
826 
827     // Replace uses of the select or its condition with the known values.
828     for (Instruction::op_iterator I = BBI->op_begin(), E = BBI->op_end();
829          I != E; ++I) {
830       if (*I == SI) {
831         *I = SI->getOperand(NonNullOperand);
832         Worklist.Add(&*BBI);
833       } else if (*I == SelectCond) {
834         *I = Builder->getInt1(NonNullOperand == 1);
835         Worklist.Add(&*BBI);
836       }
837     }
838 
839     // If we past the instruction, quit looking for it.
840     if (&*BBI == SI)
841       SI = nullptr;
842     if (&*BBI == SelectCond)
843       SelectCond = nullptr;
844 
845     // If we ran out of things to eliminate, break out of the loop.
846     if (!SelectCond && !SI)
847       break;
848 
849   }
850   return true;
851 }
852 
853 
854 /// This function implements the transforms common to both integer division
855 /// instructions (udiv and sdiv). It is called by the visitors to those integer
856 /// division instructions.
857 /// @brief Common integer divide transforms
858 Instruction *InstCombiner::commonIDivTransforms(BinaryOperator &I) {
859   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
860 
861   // The RHS is known non-zero.
862   if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I)) {
863     I.setOperand(1, V);
864     return &I;
865   }
866 
867   // Handle cases involving: [su]div X, (select Cond, Y, Z)
868   // This does not apply for fdiv.
869   if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
870     return &I;
871 
872   if (Instruction *LHS = dyn_cast<Instruction>(Op0)) {
873     const APInt *C2;
874     if (match(Op1, m_APInt(C2))) {
875       Value *X;
876       const APInt *C1;
877       bool IsSigned = I.getOpcode() == Instruction::SDiv;
878 
879       // (X / C1) / C2  -> X / (C1*C2)
880       if ((IsSigned && match(LHS, m_SDiv(m_Value(X), m_APInt(C1)))) ||
881           (!IsSigned && match(LHS, m_UDiv(m_Value(X), m_APInt(C1))))) {
882         APInt Product(C1->getBitWidth(), /*Val=*/0ULL, IsSigned);
883         if (!MultiplyOverflows(*C1, *C2, Product, IsSigned))
884           return BinaryOperator::Create(I.getOpcode(), X,
885                                         ConstantInt::get(I.getType(), Product));
886       }
887 
888       if ((IsSigned && match(LHS, m_NSWMul(m_Value(X), m_APInt(C1)))) ||
889           (!IsSigned && match(LHS, m_NUWMul(m_Value(X), m_APInt(C1))))) {
890         APInt Quotient(C1->getBitWidth(), /*Val=*/0ULL, IsSigned);
891 
892         // (X * C1) / C2 -> X / (C2 / C1) if C2 is a multiple of C1.
893         if (IsMultiple(*C2, *C1, Quotient, IsSigned)) {
894           BinaryOperator *BO = BinaryOperator::Create(
895               I.getOpcode(), X, ConstantInt::get(X->getType(), Quotient));
896           BO->setIsExact(I.isExact());
897           return BO;
898         }
899 
900         // (X * C1) / C2 -> X * (C1 / C2) if C1 is a multiple of C2.
901         if (IsMultiple(*C1, *C2, Quotient, IsSigned)) {
902           BinaryOperator *BO = BinaryOperator::Create(
903               Instruction::Mul, X, ConstantInt::get(X->getType(), Quotient));
904           BO->setHasNoUnsignedWrap(
905               !IsSigned &&
906               cast<OverflowingBinaryOperator>(LHS)->hasNoUnsignedWrap());
907           BO->setHasNoSignedWrap(
908               cast<OverflowingBinaryOperator>(LHS)->hasNoSignedWrap());
909           return BO;
910         }
911       }
912 
913       if ((IsSigned && match(LHS, m_NSWShl(m_Value(X), m_APInt(C1))) &&
914            *C1 != C1->getBitWidth() - 1) ||
915           (!IsSigned && match(LHS, m_NUWShl(m_Value(X), m_APInt(C1))))) {
916         APInt Quotient(C1->getBitWidth(), /*Val=*/0ULL, IsSigned);
917         APInt C1Shifted = APInt::getOneBitSet(
918             C1->getBitWidth(), static_cast<unsigned>(C1->getLimitedValue()));
919 
920         // (X << C1) / C2 -> X / (C2 >> C1) if C2 is a multiple of C1.
921         if (IsMultiple(*C2, C1Shifted, Quotient, IsSigned)) {
922           BinaryOperator *BO = BinaryOperator::Create(
923               I.getOpcode(), X, ConstantInt::get(X->getType(), Quotient));
924           BO->setIsExact(I.isExact());
925           return BO;
926         }
927 
928         // (X << C1) / C2 -> X * (C2 >> C1) if C1 is a multiple of C2.
929         if (IsMultiple(C1Shifted, *C2, Quotient, IsSigned)) {
930           BinaryOperator *BO = BinaryOperator::Create(
931               Instruction::Mul, X, ConstantInt::get(X->getType(), Quotient));
932           BO->setHasNoUnsignedWrap(
933               !IsSigned &&
934               cast<OverflowingBinaryOperator>(LHS)->hasNoUnsignedWrap());
935           BO->setHasNoSignedWrap(
936               cast<OverflowingBinaryOperator>(LHS)->hasNoSignedWrap());
937           return BO;
938         }
939       }
940 
941       if (*C2 != 0) // avoid X udiv 0
942         if (Instruction *FoldedDiv = foldOpWithConstantIntoOperand(I))
943           return FoldedDiv;
944     }
945   }
946 
947   if (ConstantInt *One = dyn_cast<ConstantInt>(Op0)) {
948     if (One->isOne() && !I.getType()->isIntegerTy(1)) {
949       bool isSigned = I.getOpcode() == Instruction::SDiv;
950       if (isSigned) {
951         // If Op1 is 0 then it's undefined behaviour, if Op1 is 1 then the
952         // result is one, if Op1 is -1 then the result is minus one, otherwise
953         // it's zero.
954         Value *Inc = Builder->CreateAdd(Op1, One);
955         Value *Cmp = Builder->CreateICmpULT(
956                          Inc, ConstantInt::get(I.getType(), 3));
957         return SelectInst::Create(Cmp, Op1, ConstantInt::get(I.getType(), 0));
958       } else {
959         // If Op1 is 0 then it's undefined behaviour. If Op1 is 1 then the
960         // result is one, otherwise it's zero.
961         return new ZExtInst(Builder->CreateICmpEQ(Op1, One), I.getType());
962       }
963     }
964   }
965 
966   // See if we can fold away this div instruction.
967   if (SimplifyDemandedInstructionBits(I))
968     return &I;
969 
970   // (X - (X rem Y)) / Y -> X / Y; usually originates as ((X / Y) * Y) / Y
971   Value *X = nullptr, *Z = nullptr;
972   if (match(Op0, m_Sub(m_Value(X), m_Value(Z)))) { // (X - Z) / Y; Y = Op1
973     bool isSigned = I.getOpcode() == Instruction::SDiv;
974     if ((isSigned && match(Z, m_SRem(m_Specific(X), m_Specific(Op1)))) ||
975         (!isSigned && match(Z, m_URem(m_Specific(X), m_Specific(Op1)))))
976       return BinaryOperator::Create(I.getOpcode(), X, Op1);
977   }
978 
979   return nullptr;
980 }
981 
982 /// dyn_castZExtVal - Checks if V is a zext or constant that can
983 /// be truncated to Ty without losing bits.
984 static Value *dyn_castZExtVal(Value *V, Type *Ty) {
985   if (ZExtInst *Z = dyn_cast<ZExtInst>(V)) {
986     if (Z->getSrcTy() == Ty)
987       return Z->getOperand(0);
988   } else if (ConstantInt *C = dyn_cast<ConstantInt>(V)) {
989     if (C->getValue().getActiveBits() <= cast<IntegerType>(Ty)->getBitWidth())
990       return ConstantExpr::getTrunc(C, Ty);
991   }
992   return nullptr;
993 }
994 
995 namespace {
996 const unsigned MaxDepth = 6;
997 typedef Instruction *(*FoldUDivOperandCb)(Value *Op0, Value *Op1,
998                                           const BinaryOperator &I,
999                                           InstCombiner &IC);
1000 
1001 /// \brief Used to maintain state for visitUDivOperand().
1002 struct UDivFoldAction {
1003   FoldUDivOperandCb FoldAction; ///< Informs visitUDiv() how to fold this
1004                                 ///< operand.  This can be zero if this action
1005                                 ///< joins two actions together.
1006 
1007   Value *OperandToFold;         ///< Which operand to fold.
1008   union {
1009     Instruction *FoldResult;    ///< The instruction returned when FoldAction is
1010                                 ///< invoked.
1011 
1012     size_t SelectLHSIdx;        ///< Stores the LHS action index if this action
1013                                 ///< joins two actions together.
1014   };
1015 
1016   UDivFoldAction(FoldUDivOperandCb FA, Value *InputOperand)
1017       : FoldAction(FA), OperandToFold(InputOperand), FoldResult(nullptr) {}
1018   UDivFoldAction(FoldUDivOperandCb FA, Value *InputOperand, size_t SLHS)
1019       : FoldAction(FA), OperandToFold(InputOperand), SelectLHSIdx(SLHS) {}
1020 };
1021 }
1022 
1023 // X udiv 2^C -> X >> C
1024 static Instruction *foldUDivPow2Cst(Value *Op0, Value *Op1,
1025                                     const BinaryOperator &I, InstCombiner &IC) {
1026   const APInt &C = cast<Constant>(Op1)->getUniqueInteger();
1027   BinaryOperator *LShr = BinaryOperator::CreateLShr(
1028       Op0, ConstantInt::get(Op0->getType(), C.logBase2()));
1029   if (I.isExact())
1030     LShr->setIsExact();
1031   return LShr;
1032 }
1033 
1034 // X udiv C, where C >= signbit
1035 static Instruction *foldUDivNegCst(Value *Op0, Value *Op1,
1036                                    const BinaryOperator &I, InstCombiner &IC) {
1037   Value *ICI = IC.Builder->CreateICmpULT(Op0, cast<ConstantInt>(Op1));
1038 
1039   return SelectInst::Create(ICI, Constant::getNullValue(I.getType()),
1040                             ConstantInt::get(I.getType(), 1));
1041 }
1042 
1043 // X udiv (C1 << N), where C1 is "1<<C2"  -->  X >> (N+C2)
1044 // X udiv (zext (C1 << N)), where C1 is "1<<C2"  -->  X >> (N+C2)
1045 static Instruction *foldUDivShl(Value *Op0, Value *Op1, const BinaryOperator &I,
1046                                 InstCombiner &IC) {
1047   Value *ShiftLeft;
1048   if (!match(Op1, m_ZExt(m_Value(ShiftLeft))))
1049     ShiftLeft = Op1;
1050 
1051   const APInt *CI;
1052   Value *N;
1053   if (!match(ShiftLeft, m_Shl(m_APInt(CI), m_Value(N))))
1054     llvm_unreachable("match should never fail here!");
1055   if (*CI != 1)
1056     N = IC.Builder->CreateAdd(N,
1057                               ConstantInt::get(N->getType(), CI->logBase2()));
1058   if (Op1 != ShiftLeft)
1059     N = IC.Builder->CreateZExt(N, Op1->getType());
1060   BinaryOperator *LShr = BinaryOperator::CreateLShr(Op0, N);
1061   if (I.isExact())
1062     LShr->setIsExact();
1063   return LShr;
1064 }
1065 
1066 // \brief Recursively visits the possible right hand operands of a udiv
1067 // instruction, seeing through select instructions, to determine if we can
1068 // replace the udiv with something simpler.  If we find that an operand is not
1069 // able to simplify the udiv, we abort the entire transformation.
1070 static size_t visitUDivOperand(Value *Op0, Value *Op1, const BinaryOperator &I,
1071                                SmallVectorImpl<UDivFoldAction> &Actions,
1072                                unsigned Depth = 0) {
1073   // Check to see if this is an unsigned division with an exact power of 2,
1074   // if so, convert to a right shift.
1075   if (match(Op1, m_Power2())) {
1076     Actions.push_back(UDivFoldAction(foldUDivPow2Cst, Op1));
1077     return Actions.size();
1078   }
1079 
1080   if (ConstantInt *C = dyn_cast<ConstantInt>(Op1))
1081     // X udiv C, where C >= signbit
1082     if (C->getValue().isNegative()) {
1083       Actions.push_back(UDivFoldAction(foldUDivNegCst, C));
1084       return Actions.size();
1085     }
1086 
1087   // X udiv (C1 << N), where C1 is "1<<C2"  -->  X >> (N+C2)
1088   if (match(Op1, m_Shl(m_Power2(), m_Value())) ||
1089       match(Op1, m_ZExt(m_Shl(m_Power2(), m_Value())))) {
1090     Actions.push_back(UDivFoldAction(foldUDivShl, Op1));
1091     return Actions.size();
1092   }
1093 
1094   // The remaining tests are all recursive, so bail out if we hit the limit.
1095   if (Depth++ == MaxDepth)
1096     return 0;
1097 
1098   if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
1099     if (size_t LHSIdx =
1100             visitUDivOperand(Op0, SI->getOperand(1), I, Actions, Depth))
1101       if (visitUDivOperand(Op0, SI->getOperand(2), I, Actions, Depth)) {
1102         Actions.push_back(UDivFoldAction(nullptr, Op1, LHSIdx - 1));
1103         return Actions.size();
1104       }
1105 
1106   return 0;
1107 }
1108 
1109 Instruction *InstCombiner::visitUDiv(BinaryOperator &I) {
1110   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1111 
1112   if (Value *V = SimplifyVectorOp(I))
1113     return replaceInstUsesWith(I, V);
1114 
1115   if (Value *V = SimplifyUDivInst(Op0, Op1, DL, &TLI, &DT, &AC))
1116     return replaceInstUsesWith(I, V);
1117 
1118   // Handle the integer div common cases
1119   if (Instruction *Common = commonIDivTransforms(I))
1120     return Common;
1121 
1122   // (x lshr C1) udiv C2 --> x udiv (C2 << C1)
1123   {
1124     Value *X;
1125     const APInt *C1, *C2;
1126     if (match(Op0, m_LShr(m_Value(X), m_APInt(C1))) &&
1127         match(Op1, m_APInt(C2))) {
1128       bool Overflow;
1129       APInt C2ShlC1 = C2->ushl_ov(*C1, Overflow);
1130       if (!Overflow) {
1131         bool IsExact = I.isExact() && match(Op0, m_Exact(m_Value()));
1132         BinaryOperator *BO = BinaryOperator::CreateUDiv(
1133             X, ConstantInt::get(X->getType(), C2ShlC1));
1134         if (IsExact)
1135           BO->setIsExact();
1136         return BO;
1137       }
1138     }
1139   }
1140 
1141   // (zext A) udiv (zext B) --> zext (A udiv B)
1142   if (ZExtInst *ZOp0 = dyn_cast<ZExtInst>(Op0))
1143     if (Value *ZOp1 = dyn_castZExtVal(Op1, ZOp0->getSrcTy()))
1144       return new ZExtInst(
1145           Builder->CreateUDiv(ZOp0->getOperand(0), ZOp1, "div", I.isExact()),
1146           I.getType());
1147 
1148   // (LHS udiv (select (select (...)))) -> (LHS >> (select (select (...))))
1149   SmallVector<UDivFoldAction, 6> UDivActions;
1150   if (visitUDivOperand(Op0, Op1, I, UDivActions))
1151     for (unsigned i = 0, e = UDivActions.size(); i != e; ++i) {
1152       FoldUDivOperandCb Action = UDivActions[i].FoldAction;
1153       Value *ActionOp1 = UDivActions[i].OperandToFold;
1154       Instruction *Inst;
1155       if (Action)
1156         Inst = Action(Op0, ActionOp1, I, *this);
1157       else {
1158         // This action joins two actions together.  The RHS of this action is
1159         // simply the last action we processed, we saved the LHS action index in
1160         // the joining action.
1161         size_t SelectRHSIdx = i - 1;
1162         Value *SelectRHS = UDivActions[SelectRHSIdx].FoldResult;
1163         size_t SelectLHSIdx = UDivActions[i].SelectLHSIdx;
1164         Value *SelectLHS = UDivActions[SelectLHSIdx].FoldResult;
1165         Inst = SelectInst::Create(cast<SelectInst>(ActionOp1)->getCondition(),
1166                                   SelectLHS, SelectRHS);
1167       }
1168 
1169       // If this is the last action to process, return it to the InstCombiner.
1170       // Otherwise, we insert it before the UDiv and record it so that we may
1171       // use it as part of a joining action (i.e., a SelectInst).
1172       if (e - i != 1) {
1173         Inst->insertBefore(&I);
1174         UDivActions[i].FoldResult = Inst;
1175       } else
1176         return Inst;
1177     }
1178 
1179   return nullptr;
1180 }
1181 
1182 Instruction *InstCombiner::visitSDiv(BinaryOperator &I) {
1183   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1184 
1185   if (Value *V = SimplifyVectorOp(I))
1186     return replaceInstUsesWith(I, V);
1187 
1188   if (Value *V = SimplifySDivInst(Op0, Op1, DL, &TLI, &DT, &AC))
1189     return replaceInstUsesWith(I, V);
1190 
1191   // Handle the integer div common cases
1192   if (Instruction *Common = commonIDivTransforms(I))
1193     return Common;
1194 
1195   const APInt *Op1C;
1196   if (match(Op1, m_APInt(Op1C))) {
1197     // sdiv X, -1 == -X
1198     if (Op1C->isAllOnesValue())
1199       return BinaryOperator::CreateNeg(Op0);
1200 
1201     // sdiv exact X, C  -->  ashr exact X, log2(C)
1202     if (I.isExact() && Op1C->isNonNegative() && Op1C->isPowerOf2()) {
1203       Value *ShAmt = ConstantInt::get(Op1->getType(), Op1C->exactLogBase2());
1204       return BinaryOperator::CreateExactAShr(Op0, ShAmt, I.getName());
1205     }
1206 
1207     // If the dividend is sign-extended and the constant divisor is small enough
1208     // to fit in the source type, shrink the division to the narrower type:
1209     // (sext X) sdiv C --> sext (X sdiv C)
1210     Value *Op0Src;
1211     if (match(Op0, m_OneUse(m_SExt(m_Value(Op0Src)))) &&
1212         Op0Src->getType()->getScalarSizeInBits() >= Op1C->getMinSignedBits()) {
1213 
1214       // In the general case, we need to make sure that the dividend is not the
1215       // minimum signed value because dividing that by -1 is UB. But here, we
1216       // know that the -1 divisor case is already handled above.
1217 
1218       Constant *NarrowDivisor =
1219           ConstantExpr::getTrunc(cast<Constant>(Op1), Op0Src->getType());
1220       Value *NarrowOp = Builder->CreateSDiv(Op0Src, NarrowDivisor);
1221       return new SExtInst(NarrowOp, Op0->getType());
1222     }
1223   }
1224 
1225   if (Constant *RHS = dyn_cast<Constant>(Op1)) {
1226     // X/INT_MIN -> X == INT_MIN
1227     if (RHS->isMinSignedValue())
1228       return new ZExtInst(Builder->CreateICmpEQ(Op0, Op1), I.getType());
1229 
1230     // -X/C  -->  X/-C  provided the negation doesn't overflow.
1231     Value *X;
1232     if (match(Op0, m_NSWSub(m_Zero(), m_Value(X)))) {
1233       auto *BO = BinaryOperator::CreateSDiv(X, ConstantExpr::getNeg(RHS));
1234       BO->setIsExact(I.isExact());
1235       return BO;
1236     }
1237   }
1238 
1239   // If the sign bits of both operands are zero (i.e. we can prove they are
1240   // unsigned inputs), turn this into a udiv.
1241   if (I.getType()->isIntegerTy()) {
1242     APInt Mask(APInt::getSignBit(I.getType()->getPrimitiveSizeInBits()));
1243     if (MaskedValueIsZero(Op0, Mask, 0, &I)) {
1244       if (MaskedValueIsZero(Op1, Mask, 0, &I)) {
1245         // X sdiv Y -> X udiv Y, iff X and Y don't have sign bit set
1246         auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
1247         BO->setIsExact(I.isExact());
1248         return BO;
1249       }
1250 
1251       if (isKnownToBeAPowerOfTwo(Op1, DL, /*OrZero*/ true, 0, &AC, &I, &DT)) {
1252         // X sdiv (1 << Y) -> X udiv (1 << Y) ( -> X u>> Y)
1253         // Safe because the only negative value (1 << Y) can take on is
1254         // INT_MIN, and X sdiv INT_MIN == X udiv INT_MIN == 0 if X doesn't have
1255         // the sign bit set.
1256         auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
1257         BO->setIsExact(I.isExact());
1258         return BO;
1259       }
1260     }
1261   }
1262 
1263   return nullptr;
1264 }
1265 
1266 /// CvtFDivConstToReciprocal tries to convert X/C into X*1/C if C not a special
1267 /// FP value and:
1268 ///    1) 1/C is exact, or
1269 ///    2) reciprocal is allowed.
1270 /// If the conversion was successful, the simplified expression "X * 1/C" is
1271 /// returned; otherwise, NULL is returned.
1272 ///
1273 static Instruction *CvtFDivConstToReciprocal(Value *Dividend, Constant *Divisor,
1274                                              bool AllowReciprocal) {
1275   if (!isa<ConstantFP>(Divisor)) // TODO: handle vectors.
1276     return nullptr;
1277 
1278   const APFloat &FpVal = cast<ConstantFP>(Divisor)->getValueAPF();
1279   APFloat Reciprocal(FpVal.getSemantics());
1280   bool Cvt = FpVal.getExactInverse(&Reciprocal);
1281 
1282   if (!Cvt && AllowReciprocal && FpVal.isFiniteNonZero()) {
1283     Reciprocal = APFloat(FpVal.getSemantics(), 1.0f);
1284     (void)Reciprocal.divide(FpVal, APFloat::rmNearestTiesToEven);
1285     Cvt = !Reciprocal.isDenormal();
1286   }
1287 
1288   if (!Cvt)
1289     return nullptr;
1290 
1291   ConstantFP *R;
1292   R = ConstantFP::get(Dividend->getType()->getContext(), Reciprocal);
1293   return BinaryOperator::CreateFMul(Dividend, R);
1294 }
1295 
1296 Instruction *InstCombiner::visitFDiv(BinaryOperator &I) {
1297   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1298 
1299   if (Value *V = SimplifyVectorOp(I))
1300     return replaceInstUsesWith(I, V);
1301 
1302   if (Value *V = SimplifyFDivInst(Op0, Op1, I.getFastMathFlags(),
1303                                   DL, &TLI, &DT, &AC))
1304     return replaceInstUsesWith(I, V);
1305 
1306   if (isa<Constant>(Op0))
1307     if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
1308       if (Instruction *R = FoldOpIntoSelect(I, SI))
1309         return R;
1310 
1311   bool AllowReassociate = I.hasUnsafeAlgebra();
1312   bool AllowReciprocal = I.hasAllowReciprocal();
1313 
1314   if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
1315     if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
1316       if (Instruction *R = FoldOpIntoSelect(I, SI))
1317         return R;
1318 
1319     if (AllowReassociate) {
1320       Constant *C1 = nullptr;
1321       Constant *C2 = Op1C;
1322       Value *X;
1323       Instruction *Res = nullptr;
1324 
1325       if (match(Op0, m_FMul(m_Value(X), m_Constant(C1)))) {
1326         // (X*C1)/C2 => X * (C1/C2)
1327         //
1328         Constant *C = ConstantExpr::getFDiv(C1, C2);
1329         if (isNormalFp(C))
1330           Res = BinaryOperator::CreateFMul(X, C);
1331       } else if (match(Op0, m_FDiv(m_Value(X), m_Constant(C1)))) {
1332         // (X/C1)/C2 => X /(C2*C1) [=> X * 1/(C2*C1) if reciprocal is allowed]
1333         //
1334         Constant *C = ConstantExpr::getFMul(C1, C2);
1335         if (isNormalFp(C)) {
1336           Res = CvtFDivConstToReciprocal(X, C, AllowReciprocal);
1337           if (!Res)
1338             Res = BinaryOperator::CreateFDiv(X, C);
1339         }
1340       }
1341 
1342       if (Res) {
1343         Res->setFastMathFlags(I.getFastMathFlags());
1344         return Res;
1345       }
1346     }
1347 
1348     // X / C => X * 1/C
1349     if (Instruction *T = CvtFDivConstToReciprocal(Op0, Op1C, AllowReciprocal)) {
1350       T->copyFastMathFlags(&I);
1351       return T;
1352     }
1353 
1354     return nullptr;
1355   }
1356 
1357   if (AllowReassociate && isa<Constant>(Op0)) {
1358     Constant *C1 = cast<Constant>(Op0), *C2;
1359     Constant *Fold = nullptr;
1360     Value *X;
1361     bool CreateDiv = true;
1362 
1363     // C1 / (X*C2) => (C1/C2) / X
1364     if (match(Op1, m_FMul(m_Value(X), m_Constant(C2))))
1365       Fold = ConstantExpr::getFDiv(C1, C2);
1366     else if (match(Op1, m_FDiv(m_Value(X), m_Constant(C2)))) {
1367       // C1 / (X/C2) => (C1*C2) / X
1368       Fold = ConstantExpr::getFMul(C1, C2);
1369     } else if (match(Op1, m_FDiv(m_Constant(C2), m_Value(X)))) {
1370       // C1 / (C2/X) => (C1/C2) * X
1371       Fold = ConstantExpr::getFDiv(C1, C2);
1372       CreateDiv = false;
1373     }
1374 
1375     if (Fold && isNormalFp(Fold)) {
1376       Instruction *R = CreateDiv ? BinaryOperator::CreateFDiv(Fold, X)
1377                                  : BinaryOperator::CreateFMul(X, Fold);
1378       R->setFastMathFlags(I.getFastMathFlags());
1379       return R;
1380     }
1381     return nullptr;
1382   }
1383 
1384   if (AllowReassociate) {
1385     Value *X, *Y;
1386     Value *NewInst = nullptr;
1387     Instruction *SimpR = nullptr;
1388 
1389     if (Op0->hasOneUse() && match(Op0, m_FDiv(m_Value(X), m_Value(Y)))) {
1390       // (X/Y) / Z => X / (Y*Z)
1391       //
1392       if (!isa<Constant>(Y) || !isa<Constant>(Op1)) {
1393         NewInst = Builder->CreateFMul(Y, Op1);
1394         if (Instruction *RI = dyn_cast<Instruction>(NewInst)) {
1395           FastMathFlags Flags = I.getFastMathFlags();
1396           Flags &= cast<Instruction>(Op0)->getFastMathFlags();
1397           RI->setFastMathFlags(Flags);
1398         }
1399         SimpR = BinaryOperator::CreateFDiv(X, NewInst);
1400       }
1401     } else if (Op1->hasOneUse() && match(Op1, m_FDiv(m_Value(X), m_Value(Y)))) {
1402       // Z / (X/Y) => Z*Y / X
1403       //
1404       if (!isa<Constant>(Y) || !isa<Constant>(Op0)) {
1405         NewInst = Builder->CreateFMul(Op0, Y);
1406         if (Instruction *RI = dyn_cast<Instruction>(NewInst)) {
1407           FastMathFlags Flags = I.getFastMathFlags();
1408           Flags &= cast<Instruction>(Op1)->getFastMathFlags();
1409           RI->setFastMathFlags(Flags);
1410         }
1411         SimpR = BinaryOperator::CreateFDiv(NewInst, X);
1412       }
1413     }
1414 
1415     if (NewInst) {
1416       if (Instruction *T = dyn_cast<Instruction>(NewInst))
1417         T->setDebugLoc(I.getDebugLoc());
1418       SimpR->setFastMathFlags(I.getFastMathFlags());
1419       return SimpR;
1420     }
1421   }
1422 
1423   Value *LHS;
1424   Value *RHS;
1425 
1426   // -x / -y -> x / y
1427   if (match(Op0, m_FNeg(m_Value(LHS))) && match(Op1, m_FNeg(m_Value(RHS)))) {
1428     I.setOperand(0, LHS);
1429     I.setOperand(1, RHS);
1430     return &I;
1431   }
1432 
1433   return nullptr;
1434 }
1435 
1436 /// This function implements the transforms common to both integer remainder
1437 /// instructions (urem and srem). It is called by the visitors to those integer
1438 /// remainder instructions.
1439 /// @brief Common integer remainder transforms
1440 Instruction *InstCombiner::commonIRemTransforms(BinaryOperator &I) {
1441   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1442 
1443   // The RHS is known non-zero.
1444   if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I)) {
1445     I.setOperand(1, V);
1446     return &I;
1447   }
1448 
1449   // Handle cases involving: rem X, (select Cond, Y, Z)
1450   if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
1451     return &I;
1452 
1453   if (isa<Constant>(Op1)) {
1454     if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
1455       if (SelectInst *SI = dyn_cast<SelectInst>(Op0I)) {
1456         if (Instruction *R = FoldOpIntoSelect(I, SI))
1457           return R;
1458       } else if (isa<PHINode>(Op0I)) {
1459         using namespace llvm::PatternMatch;
1460         const APInt *Op1Int;
1461         if (match(Op1, m_APInt(Op1Int)) && !Op1Int->isMinValue() &&
1462             (I.getOpcode() == Instruction::URem ||
1463              !Op1Int->isMinSignedValue())) {
1464           // FoldOpIntoPhi will speculate instructions to the end of the PHI's
1465           // predecessor blocks, so do this only if we know the srem or urem
1466           // will not fault.
1467           if (Instruction *NV = FoldOpIntoPhi(I))
1468             return NV;
1469         }
1470       }
1471 
1472       // See if we can fold away this rem instruction.
1473       if (SimplifyDemandedInstructionBits(I))
1474         return &I;
1475     }
1476   }
1477 
1478   return nullptr;
1479 }
1480 
1481 Instruction *InstCombiner::visitURem(BinaryOperator &I) {
1482   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1483 
1484   if (Value *V = SimplifyVectorOp(I))
1485     return replaceInstUsesWith(I, V);
1486 
1487   if (Value *V = SimplifyURemInst(Op0, Op1, DL, &TLI, &DT, &AC))
1488     return replaceInstUsesWith(I, V);
1489 
1490   if (Instruction *common = commonIRemTransforms(I))
1491     return common;
1492 
1493   // (zext A) urem (zext B) --> zext (A urem B)
1494   if (ZExtInst *ZOp0 = dyn_cast<ZExtInst>(Op0))
1495     if (Value *ZOp1 = dyn_castZExtVal(Op1, ZOp0->getSrcTy()))
1496       return new ZExtInst(Builder->CreateURem(ZOp0->getOperand(0), ZOp1),
1497                           I.getType());
1498 
1499   // X urem Y -> X and Y-1, where Y is a power of 2,
1500   if (isKnownToBeAPowerOfTwo(Op1, DL, /*OrZero*/ true, 0, &AC, &I, &DT)) {
1501     Constant *N1 = Constant::getAllOnesValue(I.getType());
1502     Value *Add = Builder->CreateAdd(Op1, N1);
1503     return BinaryOperator::CreateAnd(Op0, Add);
1504   }
1505 
1506   // 1 urem X -> zext(X != 1)
1507   if (match(Op0, m_One())) {
1508     Value *Cmp = Builder->CreateICmpNE(Op1, Op0);
1509     Value *Ext = Builder->CreateZExt(Cmp, I.getType());
1510     return replaceInstUsesWith(I, Ext);
1511   }
1512 
1513   // X urem C -> X < C ? X : X - C, where C >= signbit.
1514   const APInt *DivisorC;
1515   if (match(Op1, m_APInt(DivisorC)) && DivisorC->isNegative()) {
1516     Value *Cmp = Builder->CreateICmpULT(Op0, Op1);
1517     Value *Sub = Builder->CreateSub(Op0, Op1);
1518     return SelectInst::Create(Cmp, Op0, Sub);
1519   }
1520 
1521   return nullptr;
1522 }
1523 
1524 Instruction *InstCombiner::visitSRem(BinaryOperator &I) {
1525   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1526 
1527   if (Value *V = SimplifyVectorOp(I))
1528     return replaceInstUsesWith(I, V);
1529 
1530   if (Value *V = SimplifySRemInst(Op0, Op1, DL, &TLI, &DT, &AC))
1531     return replaceInstUsesWith(I, V);
1532 
1533   // Handle the integer rem common cases
1534   if (Instruction *Common = commonIRemTransforms(I))
1535     return Common;
1536 
1537   {
1538     const APInt *Y;
1539     // X % -Y -> X % Y
1540     if (match(Op1, m_APInt(Y)) && Y->isNegative() && !Y->isMinSignedValue()) {
1541       Worklist.AddValue(I.getOperand(1));
1542       I.setOperand(1, ConstantInt::get(I.getType(), -*Y));
1543       return &I;
1544     }
1545   }
1546 
1547   // If the sign bits of both operands are zero (i.e. we can prove they are
1548   // unsigned inputs), turn this into a urem.
1549   if (I.getType()->isIntegerTy()) {
1550     APInt Mask(APInt::getSignBit(I.getType()->getPrimitiveSizeInBits()));
1551     if (MaskedValueIsZero(Op1, Mask, 0, &I) &&
1552         MaskedValueIsZero(Op0, Mask, 0, &I)) {
1553       // X srem Y -> X urem Y, iff X and Y don't have sign bit set
1554       return BinaryOperator::CreateURem(Op0, Op1, I.getName());
1555     }
1556   }
1557 
1558   // If it's a constant vector, flip any negative values positive.
1559   if (isa<ConstantVector>(Op1) || isa<ConstantDataVector>(Op1)) {
1560     Constant *C = cast<Constant>(Op1);
1561     unsigned VWidth = C->getType()->getVectorNumElements();
1562 
1563     bool hasNegative = false;
1564     bool hasMissing = false;
1565     for (unsigned i = 0; i != VWidth; ++i) {
1566       Constant *Elt = C->getAggregateElement(i);
1567       if (!Elt) {
1568         hasMissing = true;
1569         break;
1570       }
1571 
1572       if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elt))
1573         if (RHS->isNegative())
1574           hasNegative = true;
1575     }
1576 
1577     if (hasNegative && !hasMissing) {
1578       SmallVector<Constant *, 16> Elts(VWidth);
1579       for (unsigned i = 0; i != VWidth; ++i) {
1580         Elts[i] = C->getAggregateElement(i);  // Handle undef, etc.
1581         if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elts[i])) {
1582           if (RHS->isNegative())
1583             Elts[i] = cast<ConstantInt>(ConstantExpr::getNeg(RHS));
1584         }
1585       }
1586 
1587       Constant *NewRHSV = ConstantVector::get(Elts);
1588       if (NewRHSV != C) {  // Don't loop on -MININT
1589         Worklist.AddValue(I.getOperand(1));
1590         I.setOperand(1, NewRHSV);
1591         return &I;
1592       }
1593     }
1594   }
1595 
1596   return nullptr;
1597 }
1598 
1599 Instruction *InstCombiner::visitFRem(BinaryOperator &I) {
1600   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1601 
1602   if (Value *V = SimplifyVectorOp(I))
1603     return replaceInstUsesWith(I, V);
1604 
1605   if (Value *V = SimplifyFRemInst(Op0, Op1, I.getFastMathFlags(),
1606                                   DL, &TLI, &DT, &AC))
1607     return replaceInstUsesWith(I, V);
1608 
1609   // Handle cases involving: rem X, (select Cond, Y, Z)
1610   if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
1611     return &I;
1612 
1613   return nullptr;
1614 }
1615