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