1 //===- InstCombineMulDivRem.cpp -------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the visit functions for mul, fmul, sdiv, udiv, fdiv,
10 // srem, urem, frem.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "InstCombineInternal.h"
15 #include "llvm/ADT/APInt.h"
16 #include "llvm/ADT/SmallVector.h"
17 #include "llvm/Analysis/InstructionSimplify.h"
18 #include "llvm/IR/BasicBlock.h"
19 #include "llvm/IR/Constant.h"
20 #include "llvm/IR/Constants.h"
21 #include "llvm/IR/InstrTypes.h"
22 #include "llvm/IR/Instruction.h"
23 #include "llvm/IR/Instructions.h"
24 #include "llvm/IR/IntrinsicInst.h"
25 #include "llvm/IR/Intrinsics.h"
26 #include "llvm/IR/Operator.h"
27 #include "llvm/IR/PatternMatch.h"
28 #include "llvm/IR/Type.h"
29 #include "llvm/IR/Value.h"
30 #include "llvm/Support/Casting.h"
31 #include "llvm/Support/ErrorHandling.h"
32 #include "llvm/Transforms/InstCombine/InstCombiner.h"
33 #include "llvm/Transforms/Utils/BuildLibCalls.h"
34 #include <cassert>
35 
36 #define DEBUG_TYPE "instcombine"
37 #include "llvm/Transforms/Utils/InstructionWorklist.h"
38 
39 using namespace llvm;
40 using namespace PatternMatch;
41 
42 /// The specific integer value is used in a context where it is known to be
43 /// non-zero.  If this allows us to simplify the computation, do so and return
44 /// the new operand, otherwise return null.
45 static Value *simplifyValueKnownNonZero(Value *V, InstCombinerImpl &IC,
46                                         Instruction &CxtI) {
47   // If V has multiple uses, then we would have to do more analysis to determine
48   // if this is safe.  For example, the use could be in dynamically unreached
49   // code.
50   if (!V->hasOneUse()) return nullptr;
51 
52   bool MadeChange = false;
53 
54   // ((1 << A) >>u B) --> (1 << (A-B))
55   // Because V cannot be zero, we know that B is less than A.
56   Value *A = nullptr, *B = nullptr, *One = nullptr;
57   if (match(V, m_LShr(m_OneUse(m_Shl(m_Value(One), m_Value(A))), m_Value(B))) &&
58       match(One, m_One())) {
59     A = IC.Builder.CreateSub(A, B);
60     return IC.Builder.CreateShl(One, A);
61   }
62 
63   // (PowerOfTwo >>u B) --> isExact since shifting out the result would make it
64   // inexact.  Similarly for <<.
65   BinaryOperator *I = dyn_cast<BinaryOperator>(V);
66   if (I && I->isLogicalShift() &&
67       IC.isKnownToBeAPowerOfTwo(I->getOperand(0), false, 0, &CxtI)) {
68     // We know that this is an exact/nuw shift and that the input is a
69     // non-zero context as well.
70     if (Value *V2 = simplifyValueKnownNonZero(I->getOperand(0), IC, CxtI)) {
71       IC.replaceOperand(*I, 0, V2);
72       MadeChange = true;
73     }
74 
75     if (I->getOpcode() == Instruction::LShr && !I->isExact()) {
76       I->setIsExact();
77       MadeChange = true;
78     }
79 
80     if (I->getOpcode() == Instruction::Shl && !I->hasNoUnsignedWrap()) {
81       I->setHasNoUnsignedWrap();
82       MadeChange = true;
83     }
84   }
85 
86   // TODO: Lots more we could do here:
87   //    If V is a phi node, we can call this on each of its operands.
88   //    "select cond, X, 0" can simplify to "X".
89 
90   return MadeChange ? V : nullptr;
91 }
92 
93 // TODO: This is a specific form of a much more general pattern.
94 //       We could detect a select with any binop identity constant, or we
95 //       could use SimplifyBinOp to see if either arm of the select reduces.
96 //       But that needs to be done carefully and/or while removing potential
97 //       reverse canonicalizations as in InstCombiner::foldSelectIntoOp().
98 static Value *foldMulSelectToNegate(BinaryOperator &I,
99                                     InstCombiner::BuilderTy &Builder) {
100   Value *Cond, *OtherOp;
101 
102   // mul (select Cond, 1, -1), OtherOp --> select Cond, OtherOp, -OtherOp
103   // mul OtherOp, (select Cond, 1, -1) --> select Cond, OtherOp, -OtherOp
104   if (match(&I, m_c_Mul(m_OneUse(m_Select(m_Value(Cond), m_One(), m_AllOnes())),
105                         m_Value(OtherOp)))) {
106     bool HasAnyNoWrap = I.hasNoSignedWrap() || I.hasNoUnsignedWrap();
107     Value *Neg = Builder.CreateNeg(OtherOp, "", false, HasAnyNoWrap);
108     return Builder.CreateSelect(Cond, OtherOp, Neg);
109   }
110   // mul (select Cond, -1, 1), OtherOp --> select Cond, -OtherOp, OtherOp
111   // mul OtherOp, (select Cond, -1, 1) --> select Cond, -OtherOp, OtherOp
112   if (match(&I, m_c_Mul(m_OneUse(m_Select(m_Value(Cond), m_AllOnes(), m_One())),
113                         m_Value(OtherOp)))) {
114     bool HasAnyNoWrap = I.hasNoSignedWrap() || I.hasNoUnsignedWrap();
115     Value *Neg = Builder.CreateNeg(OtherOp, "", false, HasAnyNoWrap);
116     return Builder.CreateSelect(Cond, Neg, OtherOp);
117   }
118 
119   // fmul (select Cond, 1.0, -1.0), OtherOp --> select Cond, OtherOp, -OtherOp
120   // fmul OtherOp, (select Cond, 1.0, -1.0) --> select Cond, OtherOp, -OtherOp
121   if (match(&I, m_c_FMul(m_OneUse(m_Select(m_Value(Cond), m_SpecificFP(1.0),
122                                            m_SpecificFP(-1.0))),
123                          m_Value(OtherOp)))) {
124     IRBuilder<>::FastMathFlagGuard FMFGuard(Builder);
125     Builder.setFastMathFlags(I.getFastMathFlags());
126     return Builder.CreateSelect(Cond, OtherOp, Builder.CreateFNeg(OtherOp));
127   }
128 
129   // fmul (select Cond, -1.0, 1.0), OtherOp --> select Cond, -OtherOp, OtherOp
130   // fmul OtherOp, (select Cond, -1.0, 1.0) --> select Cond, -OtherOp, OtherOp
131   if (match(&I, m_c_FMul(m_OneUse(m_Select(m_Value(Cond), m_SpecificFP(-1.0),
132                                            m_SpecificFP(1.0))),
133                          m_Value(OtherOp)))) {
134     IRBuilder<>::FastMathFlagGuard FMFGuard(Builder);
135     Builder.setFastMathFlags(I.getFastMathFlags());
136     return Builder.CreateSelect(Cond, Builder.CreateFNeg(OtherOp), OtherOp);
137   }
138 
139   return nullptr;
140 }
141 
142 Instruction *InstCombinerImpl::visitMul(BinaryOperator &I) {
143   if (Value *V = SimplifyMulInst(I.getOperand(0), I.getOperand(1),
144                                  SQ.getWithInstruction(&I)))
145     return replaceInstUsesWith(I, V);
146 
147   if (SimplifyAssociativeOrCommutative(I))
148     return &I;
149 
150   if (Instruction *X = foldVectorBinop(I))
151     return X;
152 
153   if (Instruction *Phi = foldBinopWithPhiOperands(I))
154     return Phi;
155 
156   if (Value *V = SimplifyUsingDistributiveLaws(I))
157     return replaceInstUsesWith(I, V);
158 
159   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
160   unsigned BitWidth = I.getType()->getScalarSizeInBits();
161 
162   // X * -1 == 0 - X
163   if (match(Op1, m_AllOnes())) {
164     BinaryOperator *BO = BinaryOperator::CreateNeg(Op0, I.getName());
165     if (I.hasNoSignedWrap())
166       BO->setHasNoSignedWrap();
167     return BO;
168   }
169 
170   // Also allow combining multiply instructions on vectors.
171   {
172     Value *NewOp;
173     Constant *C1, *C2;
174     const APInt *IVal;
175     if (match(&I, m_Mul(m_Shl(m_Value(NewOp), m_Constant(C2)),
176                         m_Constant(C1))) &&
177         match(C1, m_APInt(IVal))) {
178       // ((X << C2)*C1) == (X * (C1 << C2))
179       Constant *Shl = ConstantExpr::getShl(C1, C2);
180       BinaryOperator *Mul = cast<BinaryOperator>(I.getOperand(0));
181       BinaryOperator *BO = BinaryOperator::CreateMul(NewOp, Shl);
182       if (I.hasNoUnsignedWrap() && Mul->hasNoUnsignedWrap())
183         BO->setHasNoUnsignedWrap();
184       if (I.hasNoSignedWrap() && Mul->hasNoSignedWrap() &&
185           Shl->isNotMinSignedValue())
186         BO->setHasNoSignedWrap();
187       return BO;
188     }
189 
190     if (match(&I, m_Mul(m_Value(NewOp), m_Constant(C1)))) {
191       // Replace X*(2^C) with X << C, where C is either a scalar or a vector.
192       if (Constant *NewCst = ConstantExpr::getExactLogBase2(C1)) {
193         BinaryOperator *Shl = BinaryOperator::CreateShl(NewOp, NewCst);
194 
195         if (I.hasNoUnsignedWrap())
196           Shl->setHasNoUnsignedWrap();
197         if (I.hasNoSignedWrap()) {
198           const APInt *V;
199           if (match(NewCst, m_APInt(V)) && *V != V->getBitWidth() - 1)
200             Shl->setHasNoSignedWrap();
201         }
202 
203         return Shl;
204       }
205     }
206   }
207 
208   if (Op0->hasOneUse() && match(Op1, m_NegatedPower2())) {
209     // Interpret  X * (-1<<C)  as  (-X) * (1<<C)  and try to sink the negation.
210     // The "* (1<<C)" thus becomes a potential shifting opportunity.
211     if (Value *NegOp0 = Negator::Negate(/*IsNegation*/ true, Op0, *this))
212       return BinaryOperator::CreateMul(
213           NegOp0, ConstantExpr::getNeg(cast<Constant>(Op1)), I.getName());
214   }
215 
216   if (Instruction *FoldedMul = foldBinOpIntoSelectOrPhi(I))
217     return FoldedMul;
218 
219   if (Value *FoldedMul = foldMulSelectToNegate(I, Builder))
220     return replaceInstUsesWith(I, FoldedMul);
221 
222   // Simplify mul instructions with a constant RHS.
223   if (isa<Constant>(Op1)) {
224     // Canonicalize (X+C1)*CI -> X*CI+C1*CI.
225     Value *X;
226     Constant *C1;
227     if (match(Op0, m_OneUse(m_Add(m_Value(X), m_Constant(C1))))) {
228       Value *Mul = Builder.CreateMul(C1, Op1);
229       // Only go forward with the transform if C1*CI simplifies to a tidier
230       // constant.
231       if (!match(Mul, m_Mul(m_Value(), m_Value())))
232         return BinaryOperator::CreateAdd(Builder.CreateMul(X, Op1), Mul);
233     }
234   }
235 
236   // abs(X) * abs(X) -> X * X
237   // nabs(X) * nabs(X) -> X * X
238   if (Op0 == Op1) {
239     Value *X, *Y;
240     SelectPatternFlavor SPF = matchSelectPattern(Op0, X, Y).Flavor;
241     if (SPF == SPF_ABS || SPF == SPF_NABS)
242       return BinaryOperator::CreateMul(X, X);
243 
244     if (match(Op0, m_Intrinsic<Intrinsic::abs>(m_Value(X))))
245       return BinaryOperator::CreateMul(X, X);
246   }
247 
248   // -X * C --> X * -C
249   Value *X, *Y;
250   Constant *Op1C;
251   if (match(Op0, m_Neg(m_Value(X))) && match(Op1, m_Constant(Op1C)))
252     return BinaryOperator::CreateMul(X, ConstantExpr::getNeg(Op1C));
253 
254   // -X * -Y --> X * Y
255   if (match(Op0, m_Neg(m_Value(X))) && match(Op1, m_Neg(m_Value(Y)))) {
256     auto *NewMul = BinaryOperator::CreateMul(X, Y);
257     if (I.hasNoSignedWrap() &&
258         cast<OverflowingBinaryOperator>(Op0)->hasNoSignedWrap() &&
259         cast<OverflowingBinaryOperator>(Op1)->hasNoSignedWrap())
260       NewMul->setHasNoSignedWrap();
261     return NewMul;
262   }
263 
264   // -X * Y --> -(X * Y)
265   // X * -Y --> -(X * Y)
266   if (match(&I, m_c_Mul(m_OneUse(m_Neg(m_Value(X))), m_Value(Y))))
267     return BinaryOperator::CreateNeg(Builder.CreateMul(X, Y));
268 
269   // (X / Y) *  Y = X - (X % Y)
270   // (X / Y) * -Y = (X % Y) - X
271   {
272     Value *Y = Op1;
273     BinaryOperator *Div = dyn_cast<BinaryOperator>(Op0);
274     if (!Div || (Div->getOpcode() != Instruction::UDiv &&
275                  Div->getOpcode() != Instruction::SDiv)) {
276       Y = Op0;
277       Div = dyn_cast<BinaryOperator>(Op1);
278     }
279     Value *Neg = dyn_castNegVal(Y);
280     if (Div && Div->hasOneUse() &&
281         (Div->getOperand(1) == Y || Div->getOperand(1) == Neg) &&
282         (Div->getOpcode() == Instruction::UDiv ||
283          Div->getOpcode() == Instruction::SDiv)) {
284       Value *X = Div->getOperand(0), *DivOp1 = Div->getOperand(1);
285 
286       // If the division is exact, X % Y is zero, so we end up with X or -X.
287       if (Div->isExact()) {
288         if (DivOp1 == Y)
289           return replaceInstUsesWith(I, X);
290         return BinaryOperator::CreateNeg(X);
291       }
292 
293       auto RemOpc = Div->getOpcode() == Instruction::UDiv ? Instruction::URem
294                                                           : Instruction::SRem;
295       // X must be frozen because we are increasing its number of uses.
296       Value *XFreeze = Builder.CreateFreeze(X, X->getName() + ".fr");
297       Value *Rem = Builder.CreateBinOp(RemOpc, XFreeze, DivOp1);
298       if (DivOp1 == Y)
299         return BinaryOperator::CreateSub(XFreeze, Rem);
300       return BinaryOperator::CreateSub(Rem, XFreeze);
301     }
302   }
303 
304   /// i1 mul -> i1 and.
305   if (I.getType()->isIntOrIntVectorTy(1))
306     return BinaryOperator::CreateAnd(Op0, Op1);
307 
308   // X*(1 << Y) --> X << Y
309   // (1 << Y)*X --> X << Y
310   {
311     Value *Y;
312     BinaryOperator *BO = nullptr;
313     bool ShlNSW = false;
314     if (match(Op0, m_Shl(m_One(), m_Value(Y)))) {
315       BO = BinaryOperator::CreateShl(Op1, Y);
316       ShlNSW = cast<ShlOperator>(Op0)->hasNoSignedWrap();
317     } else if (match(Op1, m_Shl(m_One(), m_Value(Y)))) {
318       BO = BinaryOperator::CreateShl(Op0, Y);
319       ShlNSW = cast<ShlOperator>(Op1)->hasNoSignedWrap();
320     }
321     if (BO) {
322       if (I.hasNoUnsignedWrap())
323         BO->setHasNoUnsignedWrap();
324       if (I.hasNoSignedWrap() && ShlNSW)
325         BO->setHasNoSignedWrap();
326       return BO;
327     }
328   }
329 
330   // (zext bool X) * (zext bool Y) --> zext (and X, Y)
331   // (sext bool X) * (sext bool Y) --> zext (and X, Y)
332   // Note: -1 * -1 == 1 * 1 == 1 (if the extends match, the result is the same)
333   if (((match(Op0, m_ZExt(m_Value(X))) && match(Op1, m_ZExt(m_Value(Y)))) ||
334        (match(Op0, m_SExt(m_Value(X))) && match(Op1, m_SExt(m_Value(Y))))) &&
335       X->getType()->isIntOrIntVectorTy(1) && X->getType() == Y->getType() &&
336       (Op0->hasOneUse() || Op1->hasOneUse() || X == Y)) {
337     Value *And = Builder.CreateAnd(X, Y, "mulbool");
338     return CastInst::Create(Instruction::ZExt, And, I.getType());
339   }
340   // (sext bool X) * (zext bool Y) --> sext (and X, Y)
341   // (zext bool X) * (sext bool Y) --> sext (and X, Y)
342   // Note: -1 * 1 == 1 * -1  == -1
343   if (((match(Op0, m_SExt(m_Value(X))) && match(Op1, m_ZExt(m_Value(Y)))) ||
344        (match(Op0, m_ZExt(m_Value(X))) && match(Op1, m_SExt(m_Value(Y))))) &&
345       X->getType()->isIntOrIntVectorTy(1) && X->getType() == Y->getType() &&
346       (Op0->hasOneUse() || Op1->hasOneUse())) {
347     Value *And = Builder.CreateAnd(X, Y, "mulbool");
348     return CastInst::Create(Instruction::SExt, And, I.getType());
349   }
350 
351   // (zext bool X) * Y --> X ? Y : 0
352   // Y * (zext bool X) --> X ? Y : 0
353   if (match(Op0, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
354     return SelectInst::Create(X, Op1, ConstantInt::get(I.getType(), 0));
355   if (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
356     return SelectInst::Create(X, Op0, ConstantInt::get(I.getType(), 0));
357 
358   // (sext bool X) * C --> X ? -C : 0
359   Constant *ImmC;
360   if (match(Op0, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1) &&
361       match(Op1, m_ImmConstant(ImmC))) {
362     Constant *NegC = ConstantExpr::getNeg(ImmC);
363     return SelectInst::Create(X, NegC, ConstantInt::getNullValue(I.getType()));
364   }
365 
366   // (lshr X, 31) * Y --> (X < 0) ? Y : 0
367   // TODO: We are not checking one-use because the elimination of the multiply
368   //       is better for analysis?
369   const APInt *C;
370   if (match(&I, m_c_Mul(m_LShr(m_Value(X), m_APInt(C)), m_Value(Y))) &&
371       *C == C->getBitWidth() - 1) {
372     Value *IsNeg = Builder.CreateIsNeg(X, "isneg");
373     return SelectInst::Create(IsNeg, Y, ConstantInt::getNullValue(I.getType()));
374   }
375 
376   // ((ashr X, 31) | 1) * X --> abs(X)
377   // X * ((ashr X, 31) | 1) --> abs(X)
378   if (match(&I, m_c_BinOp(m_Or(m_AShr(m_Value(X),
379                                     m_SpecificIntAllowUndef(BitWidth - 1)),
380                              m_One()),
381                         m_Deferred(X)))) {
382     Value *Abs = Builder.CreateBinaryIntrinsic(
383         Intrinsic::abs, X,
384         ConstantInt::getBool(I.getContext(), I.hasNoSignedWrap()));
385     Abs->takeName(&I);
386     return replaceInstUsesWith(I, Abs);
387   }
388 
389   if (Instruction *Ext = narrowMathIfNoOverflow(I))
390     return Ext;
391 
392   bool Changed = false;
393   if (!I.hasNoSignedWrap() && willNotOverflowSignedMul(Op0, Op1, I)) {
394     Changed = true;
395     I.setHasNoSignedWrap(true);
396   }
397 
398   if (!I.hasNoUnsignedWrap() && willNotOverflowUnsignedMul(Op0, Op1, I)) {
399     Changed = true;
400     I.setHasNoUnsignedWrap(true);
401   }
402 
403   return Changed ? &I : nullptr;
404 }
405 
406 Instruction *InstCombinerImpl::foldFPSignBitOps(BinaryOperator &I) {
407   BinaryOperator::BinaryOps Opcode = I.getOpcode();
408   assert((Opcode == Instruction::FMul || Opcode == Instruction::FDiv) &&
409          "Expected fmul or fdiv");
410 
411   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
412   Value *X, *Y;
413 
414   // -X * -Y --> X * Y
415   // -X / -Y --> X / Y
416   if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
417     return BinaryOperator::CreateWithCopiedFlags(Opcode, X, Y, &I);
418 
419   // fabs(X) * fabs(X) -> X * X
420   // fabs(X) / fabs(X) -> X / X
421   if (Op0 == Op1 && match(Op0, m_FAbs(m_Value(X))))
422     return BinaryOperator::CreateWithCopiedFlags(Opcode, X, X, &I);
423 
424   // fabs(X) * fabs(Y) --> fabs(X * Y)
425   // fabs(X) / fabs(Y) --> fabs(X / Y)
426   if (match(Op0, m_FAbs(m_Value(X))) && match(Op1, m_FAbs(m_Value(Y))) &&
427       (Op0->hasOneUse() || Op1->hasOneUse())) {
428     IRBuilder<>::FastMathFlagGuard FMFGuard(Builder);
429     Builder.setFastMathFlags(I.getFastMathFlags());
430     Value *XY = Builder.CreateBinOp(Opcode, X, Y);
431     Value *Fabs = Builder.CreateUnaryIntrinsic(Intrinsic::fabs, XY);
432     Fabs->takeName(&I);
433     return replaceInstUsesWith(I, Fabs);
434   }
435 
436   return nullptr;
437 }
438 
439 Instruction *InstCombinerImpl::visitFMul(BinaryOperator &I) {
440   if (Value *V = SimplifyFMulInst(I.getOperand(0), I.getOperand(1),
441                                   I.getFastMathFlags(),
442                                   SQ.getWithInstruction(&I)))
443     return replaceInstUsesWith(I, V);
444 
445   if (SimplifyAssociativeOrCommutative(I))
446     return &I;
447 
448   if (Instruction *X = foldVectorBinop(I))
449     return X;
450 
451   if (Instruction *Phi = foldBinopWithPhiOperands(I))
452     return Phi;
453 
454   if (Instruction *FoldedMul = foldBinOpIntoSelectOrPhi(I))
455     return FoldedMul;
456 
457   if (Value *FoldedMul = foldMulSelectToNegate(I, Builder))
458     return replaceInstUsesWith(I, FoldedMul);
459 
460   if (Instruction *R = foldFPSignBitOps(I))
461     return R;
462 
463   // X * -1.0 --> -X
464   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
465   if (match(Op1, m_SpecificFP(-1.0)))
466     return UnaryOperator::CreateFNegFMF(Op0, &I);
467 
468   // -X * C --> X * -C
469   Value *X, *Y;
470   Constant *C;
471   if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_Constant(C)))
472     return BinaryOperator::CreateFMulFMF(X, ConstantExpr::getFNeg(C), &I);
473 
474   // (select A, B, C) * (select A, D, E) --> select A, (B*D), (C*E)
475   if (Value *V = SimplifySelectsFeedingBinaryOp(I, Op0, Op1))
476     return replaceInstUsesWith(I, V);
477 
478   if (I.hasAllowReassoc()) {
479     // Reassociate constant RHS with another constant to form constant
480     // expression.
481     if (match(Op1, m_Constant(C)) && C->isFiniteNonZeroFP()) {
482       Constant *C1;
483       if (match(Op0, m_OneUse(m_FDiv(m_Constant(C1), m_Value(X))))) {
484         // (C1 / X) * C --> (C * C1) / X
485         Constant *CC1 = ConstantExpr::getFMul(C, C1);
486         if (CC1->isNormalFP())
487           return BinaryOperator::CreateFDivFMF(CC1, X, &I);
488       }
489       if (match(Op0, m_FDiv(m_Value(X), m_Constant(C1)))) {
490         // (X / C1) * C --> X * (C / C1)
491         Constant *CDivC1 = ConstantExpr::getFDiv(C, C1);
492         if (CDivC1->isNormalFP())
493           return BinaryOperator::CreateFMulFMF(X, CDivC1, &I);
494 
495         // If the constant was a denormal, try reassociating differently.
496         // (X / C1) * C --> X / (C1 / C)
497         Constant *C1DivC = ConstantExpr::getFDiv(C1, C);
498         if (Op0->hasOneUse() && C1DivC->isNormalFP())
499           return BinaryOperator::CreateFDivFMF(X, C1DivC, &I);
500       }
501 
502       // We do not need to match 'fadd C, X' and 'fsub X, C' because they are
503       // canonicalized to 'fadd X, C'. Distributing the multiply may allow
504       // further folds and (X * C) + C2 is 'fma'.
505       if (match(Op0, m_OneUse(m_FAdd(m_Value(X), m_Constant(C1))))) {
506         // (X + C1) * C --> (X * C) + (C * C1)
507         Constant *CC1 = ConstantExpr::getFMul(C, C1);
508         Value *XC = Builder.CreateFMulFMF(X, C, &I);
509         return BinaryOperator::CreateFAddFMF(XC, CC1, &I);
510       }
511       if (match(Op0, m_OneUse(m_FSub(m_Constant(C1), m_Value(X))))) {
512         // (C1 - X) * C --> (C * C1) - (X * C)
513         Constant *CC1 = ConstantExpr::getFMul(C, C1);
514         Value *XC = Builder.CreateFMulFMF(X, C, &I);
515         return BinaryOperator::CreateFSubFMF(CC1, XC, &I);
516       }
517     }
518 
519     Value *Z;
520     if (match(&I, m_c_FMul(m_OneUse(m_FDiv(m_Value(X), m_Value(Y))),
521                            m_Value(Z)))) {
522       // Sink division: (X / Y) * Z --> (X * Z) / Y
523       Value *NewFMul = Builder.CreateFMulFMF(X, Z, &I);
524       return BinaryOperator::CreateFDivFMF(NewFMul, Y, &I);
525     }
526 
527     // sqrt(X) * sqrt(Y) -> sqrt(X * Y)
528     // nnan disallows the possibility of returning a number if both operands are
529     // negative (in that case, we should return NaN).
530     if (I.hasNoNaNs() && match(Op0, m_OneUse(m_Sqrt(m_Value(X)))) &&
531         match(Op1, m_OneUse(m_Sqrt(m_Value(Y))))) {
532       Value *XY = Builder.CreateFMulFMF(X, Y, &I);
533       Value *Sqrt = Builder.CreateUnaryIntrinsic(Intrinsic::sqrt, XY, &I);
534       return replaceInstUsesWith(I, Sqrt);
535     }
536 
537     // The following transforms are done irrespective of the number of uses
538     // for the expression "1.0/sqrt(X)".
539     //  1) 1.0/sqrt(X) * X -> X/sqrt(X)
540     //  2) X * 1.0/sqrt(X) -> X/sqrt(X)
541     // We always expect the backend to reduce X/sqrt(X) to sqrt(X), if it
542     // has the necessary (reassoc) fast-math-flags.
543     if (I.hasNoSignedZeros() &&
544         match(Op0, (m_FDiv(m_SpecificFP(1.0), m_Value(Y)))) &&
545         match(Y, m_Sqrt(m_Value(X))) && Op1 == X)
546       return BinaryOperator::CreateFDivFMF(X, Y, &I);
547     if (I.hasNoSignedZeros() &&
548         match(Op1, (m_FDiv(m_SpecificFP(1.0), m_Value(Y)))) &&
549         match(Y, m_Sqrt(m_Value(X))) && Op0 == X)
550       return BinaryOperator::CreateFDivFMF(X, Y, &I);
551 
552     // Like the similar transform in instsimplify, this requires 'nsz' because
553     // sqrt(-0.0) = -0.0, and -0.0 * -0.0 does not simplify to -0.0.
554     if (I.hasNoNaNs() && I.hasNoSignedZeros() && Op0 == Op1 &&
555         Op0->hasNUses(2)) {
556       // Peek through fdiv to find squaring of square root:
557       // (X / sqrt(Y)) * (X / sqrt(Y)) --> (X * X) / Y
558       if (match(Op0, m_FDiv(m_Value(X), m_Sqrt(m_Value(Y))))) {
559         Value *XX = Builder.CreateFMulFMF(X, X, &I);
560         return BinaryOperator::CreateFDivFMF(XX, Y, &I);
561       }
562       // (sqrt(Y) / X) * (sqrt(Y) / X) --> Y / (X * X)
563       if (match(Op0, m_FDiv(m_Sqrt(m_Value(Y)), m_Value(X)))) {
564         Value *XX = Builder.CreateFMulFMF(X, X, &I);
565         return BinaryOperator::CreateFDivFMF(Y, XX, &I);
566       }
567     }
568 
569     if (I.isOnlyUserOfAnyOperand()) {
570       // pow(x, y) * pow(x, z) -> pow(x, y + z)
571       if (match(Op0, m_Intrinsic<Intrinsic::pow>(m_Value(X), m_Value(Y))) &&
572           match(Op1, m_Intrinsic<Intrinsic::pow>(m_Specific(X), m_Value(Z)))) {
573         auto *YZ = Builder.CreateFAddFMF(Y, Z, &I);
574         auto *NewPow = Builder.CreateBinaryIntrinsic(Intrinsic::pow, X, YZ, &I);
575         return replaceInstUsesWith(I, NewPow);
576       }
577 
578       // powi(x, y) * powi(x, z) -> powi(x, y + z)
579       if (match(Op0, m_Intrinsic<Intrinsic::powi>(m_Value(X), m_Value(Y))) &&
580           match(Op1, m_Intrinsic<Intrinsic::powi>(m_Specific(X), m_Value(Z))) &&
581           Y->getType() == Z->getType()) {
582         auto *YZ = Builder.CreateAdd(Y, Z);
583         auto *NewPow = Builder.CreateIntrinsic(
584             Intrinsic::powi, {X->getType(), YZ->getType()}, {X, YZ}, &I);
585         return replaceInstUsesWith(I, NewPow);
586       }
587 
588       // exp(X) * exp(Y) -> exp(X + Y)
589       if (match(Op0, m_Intrinsic<Intrinsic::exp>(m_Value(X))) &&
590           match(Op1, m_Intrinsic<Intrinsic::exp>(m_Value(Y)))) {
591         Value *XY = Builder.CreateFAddFMF(X, Y, &I);
592         Value *Exp = Builder.CreateUnaryIntrinsic(Intrinsic::exp, XY, &I);
593         return replaceInstUsesWith(I, Exp);
594       }
595 
596       // exp2(X) * exp2(Y) -> exp2(X + Y)
597       if (match(Op0, m_Intrinsic<Intrinsic::exp2>(m_Value(X))) &&
598           match(Op1, m_Intrinsic<Intrinsic::exp2>(m_Value(Y)))) {
599         Value *XY = Builder.CreateFAddFMF(X, Y, &I);
600         Value *Exp2 = Builder.CreateUnaryIntrinsic(Intrinsic::exp2, XY, &I);
601         return replaceInstUsesWith(I, Exp2);
602       }
603     }
604 
605     // (X*Y) * X => (X*X) * Y where Y != X
606     //  The purpose is two-fold:
607     //   1) to form a power expression (of X).
608     //   2) potentially shorten the critical path: After transformation, the
609     //  latency of the instruction Y is amortized by the expression of X*X,
610     //  and therefore Y is in a "less critical" position compared to what it
611     //  was before the transformation.
612     if (match(Op0, m_OneUse(m_c_FMul(m_Specific(Op1), m_Value(Y)))) &&
613         Op1 != Y) {
614       Value *XX = Builder.CreateFMulFMF(Op1, Op1, &I);
615       return BinaryOperator::CreateFMulFMF(XX, Y, &I);
616     }
617     if (match(Op1, m_OneUse(m_c_FMul(m_Specific(Op0), m_Value(Y)))) &&
618         Op0 != Y) {
619       Value *XX = Builder.CreateFMulFMF(Op0, Op0, &I);
620       return BinaryOperator::CreateFMulFMF(XX, Y, &I);
621     }
622   }
623 
624   // log2(X * 0.5) * Y = log2(X) * Y - Y
625   if (I.isFast()) {
626     IntrinsicInst *Log2 = nullptr;
627     if (match(Op0, m_OneUse(m_Intrinsic<Intrinsic::log2>(
628             m_OneUse(m_FMul(m_Value(X), m_SpecificFP(0.5))))))) {
629       Log2 = cast<IntrinsicInst>(Op0);
630       Y = Op1;
631     }
632     if (match(Op1, m_OneUse(m_Intrinsic<Intrinsic::log2>(
633             m_OneUse(m_FMul(m_Value(X), m_SpecificFP(0.5))))))) {
634       Log2 = cast<IntrinsicInst>(Op1);
635       Y = Op0;
636     }
637     if (Log2) {
638       Value *Log2 = Builder.CreateUnaryIntrinsic(Intrinsic::log2, X, &I);
639       Value *LogXTimesY = Builder.CreateFMulFMF(Log2, Y, &I);
640       return BinaryOperator::CreateFSubFMF(LogXTimesY, Y, &I);
641     }
642   }
643 
644   return nullptr;
645 }
646 
647 /// Fold a divide or remainder with a select instruction divisor when one of the
648 /// select operands is zero. In that case, we can use the other select operand
649 /// because div/rem by zero is undefined.
650 bool InstCombinerImpl::simplifyDivRemOfSelectWithZeroOp(BinaryOperator &I) {
651   SelectInst *SI = dyn_cast<SelectInst>(I.getOperand(1));
652   if (!SI)
653     return false;
654 
655   int NonNullOperand;
656   if (match(SI->getTrueValue(), m_Zero()))
657     // div/rem X, (Cond ? 0 : Y) -> div/rem X, Y
658     NonNullOperand = 2;
659   else if (match(SI->getFalseValue(), m_Zero()))
660     // div/rem X, (Cond ? Y : 0) -> div/rem X, Y
661     NonNullOperand = 1;
662   else
663     return false;
664 
665   // Change the div/rem to use 'Y' instead of the select.
666   replaceOperand(I, 1, SI->getOperand(NonNullOperand));
667 
668   // Okay, we know we replace the operand of the div/rem with 'Y' with no
669   // problem.  However, the select, or the condition of the select may have
670   // multiple uses.  Based on our knowledge that the operand must be non-zero,
671   // propagate the known value for the select into other uses of it, and
672   // propagate a known value of the condition into its other users.
673 
674   // If the select and condition only have a single use, don't bother with this,
675   // early exit.
676   Value *SelectCond = SI->getCondition();
677   if (SI->use_empty() && SelectCond->hasOneUse())
678     return true;
679 
680   // Scan the current block backward, looking for other uses of SI.
681   BasicBlock::iterator BBI = I.getIterator(), BBFront = I.getParent()->begin();
682   Type *CondTy = SelectCond->getType();
683   while (BBI != BBFront) {
684     --BBI;
685     // If we found an instruction that we can't assume will return, so
686     // information from below it cannot be propagated above it.
687     if (!isGuaranteedToTransferExecutionToSuccessor(&*BBI))
688       break;
689 
690     // Replace uses of the select or its condition with the known values.
691     for (Use &Op : BBI->operands()) {
692       if (Op == SI) {
693         replaceUse(Op, SI->getOperand(NonNullOperand));
694         Worklist.push(&*BBI);
695       } else if (Op == SelectCond) {
696         replaceUse(Op, NonNullOperand == 1 ? ConstantInt::getTrue(CondTy)
697                                            : ConstantInt::getFalse(CondTy));
698         Worklist.push(&*BBI);
699       }
700     }
701 
702     // If we past the instruction, quit looking for it.
703     if (&*BBI == SI)
704       SI = nullptr;
705     if (&*BBI == SelectCond)
706       SelectCond = nullptr;
707 
708     // If we ran out of things to eliminate, break out of the loop.
709     if (!SelectCond && !SI)
710       break;
711 
712   }
713   return true;
714 }
715 
716 /// True if the multiply can not be expressed in an int this size.
717 static bool multiplyOverflows(const APInt &C1, const APInt &C2, APInt &Product,
718                               bool IsSigned) {
719   bool Overflow;
720   Product = IsSigned ? C1.smul_ov(C2, Overflow) : C1.umul_ov(C2, Overflow);
721   return Overflow;
722 }
723 
724 /// True if C1 is a multiple of C2. Quotient contains C1/C2.
725 static bool isMultiple(const APInt &C1, const APInt &C2, APInt &Quotient,
726                        bool IsSigned) {
727   assert(C1.getBitWidth() == C2.getBitWidth() && "Constant widths not equal");
728 
729   // Bail if we will divide by zero.
730   if (C2.isZero())
731     return false;
732 
733   // Bail if we would divide INT_MIN by -1.
734   if (IsSigned && C1.isMinSignedValue() && C2.isAllOnes())
735     return false;
736 
737   APInt Remainder(C1.getBitWidth(), /*val=*/0ULL, IsSigned);
738   if (IsSigned)
739     APInt::sdivrem(C1, C2, Quotient, Remainder);
740   else
741     APInt::udivrem(C1, C2, Quotient, Remainder);
742 
743   return Remainder.isMinValue();
744 }
745 
746 /// This function implements the transforms common to both integer division
747 /// instructions (udiv and sdiv). It is called by the visitors to those integer
748 /// division instructions.
749 /// Common integer divide transforms
750 Instruction *InstCombinerImpl::commonIDivTransforms(BinaryOperator &I) {
751   if (Instruction *Phi = foldBinopWithPhiOperands(I))
752     return Phi;
753 
754   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
755   bool IsSigned = I.getOpcode() == Instruction::SDiv;
756   Type *Ty = I.getType();
757 
758   // The RHS is known non-zero.
759   if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I))
760     return replaceOperand(I, 1, V);
761 
762   // Handle cases involving: [su]div X, (select Cond, Y, Z)
763   // This does not apply for fdiv.
764   if (simplifyDivRemOfSelectWithZeroOp(I))
765     return &I;
766 
767   // If the divisor is a select-of-constants, try to constant fold all div ops:
768   // C / (select Cond, TrueC, FalseC) --> select Cond, (C / TrueC), (C / FalseC)
769   // TODO: Adapt simplifyDivRemOfSelectWithZeroOp to allow this and other folds.
770   if (match(Op0, m_ImmConstant()) &&
771       match(Op1, m_Select(m_Value(), m_ImmConstant(), m_ImmConstant()))) {
772     if (Instruction *R = FoldOpIntoSelect(I, cast<SelectInst>(Op1),
773                                           /*FoldWithMultiUse*/ true))
774       return R;
775   }
776 
777   const APInt *C2;
778   if (match(Op1, m_APInt(C2))) {
779     Value *X;
780     const APInt *C1;
781 
782     // (X / C1) / C2  -> X / (C1*C2)
783     if ((IsSigned && match(Op0, m_SDiv(m_Value(X), m_APInt(C1)))) ||
784         (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_APInt(C1))))) {
785       APInt Product(C1->getBitWidth(), /*val=*/0ULL, IsSigned);
786       if (!multiplyOverflows(*C1, *C2, Product, IsSigned))
787         return BinaryOperator::Create(I.getOpcode(), X,
788                                       ConstantInt::get(Ty, Product));
789     }
790 
791     if ((IsSigned && match(Op0, m_NSWMul(m_Value(X), m_APInt(C1)))) ||
792         (!IsSigned && match(Op0, m_NUWMul(m_Value(X), m_APInt(C1))))) {
793       APInt Quotient(C1->getBitWidth(), /*val=*/0ULL, IsSigned);
794 
795       // (X * C1) / C2 -> X / (C2 / C1) if C2 is a multiple of C1.
796       if (isMultiple(*C2, *C1, Quotient, IsSigned)) {
797         auto *NewDiv = BinaryOperator::Create(I.getOpcode(), X,
798                                               ConstantInt::get(Ty, Quotient));
799         NewDiv->setIsExact(I.isExact());
800         return NewDiv;
801       }
802 
803       // (X * C1) / C2 -> X * (C1 / C2) if C1 is a multiple of C2.
804       if (isMultiple(*C1, *C2, Quotient, IsSigned)) {
805         auto *Mul = BinaryOperator::Create(Instruction::Mul, X,
806                                            ConstantInt::get(Ty, Quotient));
807         auto *OBO = cast<OverflowingBinaryOperator>(Op0);
808         Mul->setHasNoUnsignedWrap(!IsSigned && OBO->hasNoUnsignedWrap());
809         Mul->setHasNoSignedWrap(OBO->hasNoSignedWrap());
810         return Mul;
811       }
812     }
813 
814     if ((IsSigned && match(Op0, m_NSWShl(m_Value(X), m_APInt(C1))) &&
815          C1->ult(C1->getBitWidth() - 1)) ||
816         (!IsSigned && match(Op0, m_NUWShl(m_Value(X), m_APInt(C1))) &&
817          C1->ult(C1->getBitWidth()))) {
818       APInt Quotient(C1->getBitWidth(), /*val=*/0ULL, IsSigned);
819       APInt C1Shifted = APInt::getOneBitSet(
820           C1->getBitWidth(), static_cast<unsigned>(C1->getZExtValue()));
821 
822       // (X << C1) / C2 -> X / (C2 >> C1) if C2 is a multiple of 1 << C1.
823       if (isMultiple(*C2, C1Shifted, Quotient, IsSigned)) {
824         auto *BO = BinaryOperator::Create(I.getOpcode(), X,
825                                           ConstantInt::get(Ty, Quotient));
826         BO->setIsExact(I.isExact());
827         return BO;
828       }
829 
830       // (X << C1) / C2 -> X * ((1 << C1) / C2) if 1 << C1 is a multiple of C2.
831       if (isMultiple(C1Shifted, *C2, Quotient, IsSigned)) {
832         auto *Mul = BinaryOperator::Create(Instruction::Mul, X,
833                                            ConstantInt::get(Ty, Quotient));
834         auto *OBO = cast<OverflowingBinaryOperator>(Op0);
835         Mul->setHasNoUnsignedWrap(!IsSigned && OBO->hasNoUnsignedWrap());
836         Mul->setHasNoSignedWrap(OBO->hasNoSignedWrap());
837         return Mul;
838       }
839     }
840 
841     if (!C2->isZero()) // avoid X udiv 0
842       if (Instruction *FoldedDiv = foldBinOpIntoSelectOrPhi(I))
843         return FoldedDiv;
844   }
845 
846   if (match(Op0, m_One())) {
847     assert(!Ty->isIntOrIntVectorTy(1) && "i1 divide not removed?");
848     if (IsSigned) {
849       // 1 / 0 --> undef ; 1 / 1 --> 1 ; 1 / -1 --> -1 ; 1 / anything else --> 0
850       // (Op1 + 1) u< 3 ? Op1 : 0
851       // Op1 must be frozen because we are increasing its number of uses.
852       Value *F1 = Builder.CreateFreeze(Op1, Op1->getName() + ".fr");
853       Value *Inc = Builder.CreateAdd(F1, Op0);
854       Value *Cmp = Builder.CreateICmpULT(Inc, ConstantInt::get(Ty, 3));
855       return SelectInst::Create(Cmp, F1, ConstantInt::get(Ty, 0));
856     } else {
857       // If Op1 is 0 then it's undefined behaviour. If Op1 is 1 then the
858       // result is one, otherwise it's zero.
859       return new ZExtInst(Builder.CreateICmpEQ(Op1, Op0), Ty);
860     }
861   }
862 
863   // See if we can fold away this div instruction.
864   if (SimplifyDemandedInstructionBits(I))
865     return &I;
866 
867   // (X - (X rem Y)) / Y -> X / Y; usually originates as ((X / Y) * Y) / Y
868   Value *X, *Z;
869   if (match(Op0, m_Sub(m_Value(X), m_Value(Z)))) // (X - Z) / Y; Y = Op1
870     if ((IsSigned && match(Z, m_SRem(m_Specific(X), m_Specific(Op1)))) ||
871         (!IsSigned && match(Z, m_URem(m_Specific(X), m_Specific(Op1)))))
872       return BinaryOperator::Create(I.getOpcode(), X, Op1);
873 
874   // (X << Y) / X -> 1 << Y
875   Value *Y;
876   if (IsSigned && match(Op0, m_NSWShl(m_Specific(Op1), m_Value(Y))))
877     return BinaryOperator::CreateNSWShl(ConstantInt::get(Ty, 1), Y);
878   if (!IsSigned && match(Op0, m_NUWShl(m_Specific(Op1), m_Value(Y))))
879     return BinaryOperator::CreateNUWShl(ConstantInt::get(Ty, 1), Y);
880 
881   // X / (X * Y) -> 1 / Y if the multiplication does not overflow.
882   if (match(Op1, m_c_Mul(m_Specific(Op0), m_Value(Y)))) {
883     bool HasNSW = cast<OverflowingBinaryOperator>(Op1)->hasNoSignedWrap();
884     bool HasNUW = cast<OverflowingBinaryOperator>(Op1)->hasNoUnsignedWrap();
885     if ((IsSigned && HasNSW) || (!IsSigned && HasNUW)) {
886       replaceOperand(I, 0, ConstantInt::get(Ty, 1));
887       replaceOperand(I, 1, Y);
888       return &I;
889     }
890   }
891 
892   return nullptr;
893 }
894 
895 static const unsigned MaxDepth = 6;
896 
897 // Take the exact integer log2 of the value. If DoFold is true, create the
898 // actual instructions, otherwise return a non-null dummy value. Return nullptr
899 // on failure.
900 static Value *takeLog2(IRBuilderBase &Builder, Value *Op, unsigned Depth,
901                        bool DoFold) {
902   auto IfFold = [DoFold](function_ref<Value *()> Fn) {
903     if (!DoFold)
904       return reinterpret_cast<Value *>(-1);
905     return Fn();
906   };
907 
908   // FIXME: assert that Op1 isn't/doesn't contain undef.
909 
910   // log2(2^C) -> C
911   if (match(Op, m_Power2()))
912     return IfFold([&]() {
913       Constant *C = ConstantExpr::getExactLogBase2(cast<Constant>(Op));
914       if (!C)
915         llvm_unreachable("Failed to constant fold udiv -> logbase2");
916       return C;
917     });
918 
919   // The remaining tests are all recursive, so bail out if we hit the limit.
920   if (Depth++ == MaxDepth)
921     return nullptr;
922 
923   // log2(zext X) -> zext log2(X)
924   // FIXME: Require one use?
925   Value *X, *Y;
926   if (match(Op, m_ZExt(m_Value(X))))
927     if (Value *LogX = takeLog2(Builder, X, Depth, DoFold))
928       return IfFold([&]() { return Builder.CreateZExt(LogX, Op->getType()); });
929 
930   // log2(X << Y) -> log2(X) + Y
931   // FIXME: Require one use unless X is 1?
932   if (match(Op, m_Shl(m_Value(X), m_Value(Y))))
933     if (Value *LogX = takeLog2(Builder, X, Depth, DoFold))
934       return IfFold([&]() { return Builder.CreateAdd(LogX, Y); });
935 
936   // log2(Cond ? X : Y) -> Cond ? log2(X) : log2(Y)
937   // FIXME: missed optimization: if one of the hands of select is/contains
938   //        undef, just directly pick the other one.
939   // FIXME: can both hands contain undef?
940   // FIXME: Require one use?
941   if (SelectInst *SI = dyn_cast<SelectInst>(Op))
942     if (Value *LogX = takeLog2(Builder, SI->getOperand(1), Depth, DoFold))
943       if (Value *LogY = takeLog2(Builder, SI->getOperand(2), Depth, DoFold))
944         return IfFold([&]() {
945           return Builder.CreateSelect(SI->getOperand(0), LogX, LogY);
946         });
947 
948   // log2(umin(X, Y)) -> umin(log2(X), log2(Y))
949   // log2(umax(X, Y)) -> umax(log2(X), log2(Y))
950   auto *MinMax = dyn_cast<MinMaxIntrinsic>(Op);
951   if (MinMax && MinMax->hasOneUse() && !MinMax->isSigned())
952     if (Value *LogX = takeLog2(Builder, MinMax->getLHS(), Depth, DoFold))
953       if (Value *LogY = takeLog2(Builder, MinMax->getRHS(), Depth, DoFold))
954         return IfFold([&]() {
955           return Builder.CreateBinaryIntrinsic(
956               MinMax->getIntrinsicID(), LogX, LogY);
957         });
958 
959   return nullptr;
960 }
961 
962 /// If we have zero-extended operands of an unsigned div or rem, we may be able
963 /// to narrow the operation (sink the zext below the math).
964 static Instruction *narrowUDivURem(BinaryOperator &I,
965                                    InstCombiner::BuilderTy &Builder) {
966   Instruction::BinaryOps Opcode = I.getOpcode();
967   Value *N = I.getOperand(0);
968   Value *D = I.getOperand(1);
969   Type *Ty = I.getType();
970   Value *X, *Y;
971   if (match(N, m_ZExt(m_Value(X))) && match(D, m_ZExt(m_Value(Y))) &&
972       X->getType() == Y->getType() && (N->hasOneUse() || D->hasOneUse())) {
973     // udiv (zext X), (zext Y) --> zext (udiv X, Y)
974     // urem (zext X), (zext Y) --> zext (urem X, Y)
975     Value *NarrowOp = Builder.CreateBinOp(Opcode, X, Y);
976     return new ZExtInst(NarrowOp, Ty);
977   }
978 
979   Constant *C;
980   if ((match(N, m_OneUse(m_ZExt(m_Value(X)))) && match(D, m_Constant(C))) ||
981       (match(D, m_OneUse(m_ZExt(m_Value(X)))) && match(N, m_Constant(C)))) {
982     // If the constant is the same in the smaller type, use the narrow version.
983     Constant *TruncC = ConstantExpr::getTrunc(C, X->getType());
984     if (ConstantExpr::getZExt(TruncC, Ty) != C)
985       return nullptr;
986 
987     // udiv (zext X), C --> zext (udiv X, C')
988     // urem (zext X), C --> zext (urem X, C')
989     // udiv C, (zext X) --> zext (udiv C', X)
990     // urem C, (zext X) --> zext (urem C', X)
991     Value *NarrowOp = isa<Constant>(D) ? Builder.CreateBinOp(Opcode, X, TruncC)
992                                        : Builder.CreateBinOp(Opcode, TruncC, X);
993     return new ZExtInst(NarrowOp, Ty);
994   }
995 
996   return nullptr;
997 }
998 
999 Instruction *InstCombinerImpl::visitUDiv(BinaryOperator &I) {
1000   if (Value *V = SimplifyUDivInst(I.getOperand(0), I.getOperand(1),
1001                                   SQ.getWithInstruction(&I)))
1002     return replaceInstUsesWith(I, V);
1003 
1004   if (Instruction *X = foldVectorBinop(I))
1005     return X;
1006 
1007   // Handle the integer div common cases
1008   if (Instruction *Common = commonIDivTransforms(I))
1009     return Common;
1010 
1011   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1012   Value *X;
1013   const APInt *C1, *C2;
1014   if (match(Op0, m_LShr(m_Value(X), m_APInt(C1))) && match(Op1, m_APInt(C2))) {
1015     // (X lshr C1) udiv C2 --> X udiv (C2 << C1)
1016     bool Overflow;
1017     APInt C2ShlC1 = C2->ushl_ov(*C1, Overflow);
1018     if (!Overflow) {
1019       bool IsExact = I.isExact() && match(Op0, m_Exact(m_Value()));
1020       BinaryOperator *BO = BinaryOperator::CreateUDiv(
1021           X, ConstantInt::get(X->getType(), C2ShlC1));
1022       if (IsExact)
1023         BO->setIsExact();
1024       return BO;
1025     }
1026   }
1027 
1028   // Op0 / C where C is large (negative) --> zext (Op0 >= C)
1029   // TODO: Could use isKnownNegative() to handle non-constant values.
1030   Type *Ty = I.getType();
1031   if (match(Op1, m_Negative())) {
1032     Value *Cmp = Builder.CreateICmpUGE(Op0, Op1);
1033     return CastInst::CreateZExtOrBitCast(Cmp, Ty);
1034   }
1035   // Op0 / (sext i1 X) --> zext (Op0 == -1) (if X is 0, the div is undefined)
1036   if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)) {
1037     Value *Cmp = Builder.CreateICmpEQ(Op0, ConstantInt::getAllOnesValue(Ty));
1038     return CastInst::CreateZExtOrBitCast(Cmp, Ty);
1039   }
1040 
1041   if (Instruction *NarrowDiv = narrowUDivURem(I, Builder))
1042     return NarrowDiv;
1043 
1044   // If the udiv operands are non-overflowing multiplies with a common operand,
1045   // then eliminate the common factor:
1046   // (A * B) / (A * X) --> B / X (and commuted variants)
1047   // TODO: The code would be reduced if we had m_c_NUWMul pattern matching.
1048   // TODO: If -reassociation handled this generally, we could remove this.
1049   Value *A, *B;
1050   if (match(Op0, m_NUWMul(m_Value(A), m_Value(B)))) {
1051     if (match(Op1, m_NUWMul(m_Specific(A), m_Value(X))) ||
1052         match(Op1, m_NUWMul(m_Value(X), m_Specific(A))))
1053       return BinaryOperator::CreateUDiv(B, X);
1054     if (match(Op1, m_NUWMul(m_Specific(B), m_Value(X))) ||
1055         match(Op1, m_NUWMul(m_Value(X), m_Specific(B))))
1056       return BinaryOperator::CreateUDiv(A, X);
1057   }
1058 
1059   // Op1 udiv Op2 -> Op1 lshr log2(Op2), if log2() folds away.
1060   if (takeLog2(Builder, Op1, /*Depth*/0, /*DoFold*/false)) {
1061     Value *Res = takeLog2(Builder, Op1, /*Depth*/0, /*DoFold*/true);
1062     return replaceInstUsesWith(
1063         I, Builder.CreateLShr(Op0, Res, I.getName(), I.isExact()));
1064   }
1065 
1066   return nullptr;
1067 }
1068 
1069 Instruction *InstCombinerImpl::visitSDiv(BinaryOperator &I) {
1070   if (Value *V = SimplifySDivInst(I.getOperand(0), I.getOperand(1),
1071                                   SQ.getWithInstruction(&I)))
1072     return replaceInstUsesWith(I, V);
1073 
1074   if (Instruction *X = foldVectorBinop(I))
1075     return X;
1076 
1077   // Handle the integer div common cases
1078   if (Instruction *Common = commonIDivTransforms(I))
1079     return Common;
1080 
1081   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1082   Type *Ty = I.getType();
1083   Value *X;
1084   // sdiv Op0, -1 --> -Op0
1085   // sdiv Op0, (sext i1 X) --> -Op0 (because if X is 0, the op is undefined)
1086   if (match(Op1, m_AllOnes()) ||
1087       (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
1088     return BinaryOperator::CreateNeg(Op0);
1089 
1090   // X / INT_MIN --> X == INT_MIN
1091   if (match(Op1, m_SignMask()))
1092     return new ZExtInst(Builder.CreateICmpEQ(Op0, Op1), Ty);
1093 
1094   // sdiv exact X,  1<<C  -->    ashr exact X, C   iff  1<<C  is non-negative
1095   // sdiv exact X, -1<<C  -->  -(ashr exact X, C)
1096   if (I.isExact() && ((match(Op1, m_Power2()) && match(Op1, m_NonNegative())) ||
1097                       match(Op1, m_NegatedPower2()))) {
1098     bool DivisorWasNegative = match(Op1, m_NegatedPower2());
1099     if (DivisorWasNegative)
1100       Op1 = ConstantExpr::getNeg(cast<Constant>(Op1));
1101     auto *AShr = BinaryOperator::CreateExactAShr(
1102         Op0, ConstantExpr::getExactLogBase2(cast<Constant>(Op1)), I.getName());
1103     if (!DivisorWasNegative)
1104       return AShr;
1105     Builder.Insert(AShr);
1106     AShr->setName(I.getName() + ".neg");
1107     return BinaryOperator::CreateNeg(AShr, I.getName());
1108   }
1109 
1110   const APInt *Op1C;
1111   if (match(Op1, m_APInt(Op1C))) {
1112     // If the dividend is sign-extended and the constant divisor is small enough
1113     // to fit in the source type, shrink the division to the narrower type:
1114     // (sext X) sdiv C --> sext (X sdiv C)
1115     Value *Op0Src;
1116     if (match(Op0, m_OneUse(m_SExt(m_Value(Op0Src)))) &&
1117         Op0Src->getType()->getScalarSizeInBits() >= Op1C->getMinSignedBits()) {
1118 
1119       // In the general case, we need to make sure that the dividend is not the
1120       // minimum signed value because dividing that by -1 is UB. But here, we
1121       // know that the -1 divisor case is already handled above.
1122 
1123       Constant *NarrowDivisor =
1124           ConstantExpr::getTrunc(cast<Constant>(Op1), Op0Src->getType());
1125       Value *NarrowOp = Builder.CreateSDiv(Op0Src, NarrowDivisor);
1126       return new SExtInst(NarrowOp, Ty);
1127     }
1128 
1129     // -X / C --> X / -C (if the negation doesn't overflow).
1130     // TODO: This could be enhanced to handle arbitrary vector constants by
1131     //       checking if all elements are not the min-signed-val.
1132     if (!Op1C->isMinSignedValue() &&
1133         match(Op0, m_NSWSub(m_Zero(), m_Value(X)))) {
1134       Constant *NegC = ConstantInt::get(Ty, -(*Op1C));
1135       Instruction *BO = BinaryOperator::CreateSDiv(X, NegC);
1136       BO->setIsExact(I.isExact());
1137       return BO;
1138     }
1139   }
1140 
1141   // -X / Y --> -(X / Y)
1142   Value *Y;
1143   if (match(&I, m_SDiv(m_OneUse(m_NSWSub(m_Zero(), m_Value(X))), m_Value(Y))))
1144     return BinaryOperator::CreateNSWNeg(
1145         Builder.CreateSDiv(X, Y, I.getName(), I.isExact()));
1146 
1147   // abs(X) / X --> X > -1 ? 1 : -1
1148   // X / abs(X) --> X > -1 ? 1 : -1
1149   if (match(&I, m_c_BinOp(
1150                     m_OneUse(m_Intrinsic<Intrinsic::abs>(m_Value(X), m_One())),
1151                     m_Deferred(X)))) {
1152     Value *Cond = Builder.CreateIsNotNeg(X);
1153     return SelectInst::Create(Cond, ConstantInt::get(Ty, 1),
1154                               ConstantInt::getAllOnesValue(Ty));
1155   }
1156 
1157   // If the sign bits of both operands are zero (i.e. we can prove they are
1158   // unsigned inputs), turn this into a udiv.
1159   APInt Mask(APInt::getSignMask(Ty->getScalarSizeInBits()));
1160   if (MaskedValueIsZero(Op0, Mask, 0, &I)) {
1161     if (MaskedValueIsZero(Op1, Mask, 0, &I)) {
1162       // X sdiv Y -> X udiv Y, iff X and Y don't have sign bit set
1163       auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
1164       BO->setIsExact(I.isExact());
1165       return BO;
1166     }
1167 
1168     if (match(Op1, m_NegatedPower2())) {
1169       // X sdiv (-(1 << C)) -> -(X sdiv (1 << C)) ->
1170       //                    -> -(X udiv (1 << C)) -> -(X u>> C)
1171       Constant *CNegLog2 = ConstantExpr::getExactLogBase2(
1172           ConstantExpr::getNeg(cast<Constant>(Op1)));
1173       Value *Shr = Builder.CreateLShr(Op0, CNegLog2, I.getName(), I.isExact());
1174       return BinaryOperator::CreateNeg(Shr);
1175     }
1176 
1177     if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/ true, 0, &I)) {
1178       // X sdiv (1 << Y) -> X udiv (1 << Y) ( -> X u>> Y)
1179       // Safe because the only negative value (1 << Y) can take on is
1180       // INT_MIN, and X sdiv INT_MIN == X udiv INT_MIN == 0 if X doesn't have
1181       // the sign bit set.
1182       auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
1183       BO->setIsExact(I.isExact());
1184       return BO;
1185     }
1186   }
1187 
1188   return nullptr;
1189 }
1190 
1191 /// Remove negation and try to convert division into multiplication.
1192 static Instruction *foldFDivConstantDivisor(BinaryOperator &I) {
1193   Constant *C;
1194   if (!match(I.getOperand(1), m_Constant(C)))
1195     return nullptr;
1196 
1197   // -X / C --> X / -C
1198   Value *X;
1199   if (match(I.getOperand(0), m_FNeg(m_Value(X))))
1200     return BinaryOperator::CreateFDivFMF(X, ConstantExpr::getFNeg(C), &I);
1201 
1202   // If the constant divisor has an exact inverse, this is always safe. If not,
1203   // then we can still create a reciprocal if fast-math-flags allow it and the
1204   // constant is a regular number (not zero, infinite, or denormal).
1205   if (!(C->hasExactInverseFP() || (I.hasAllowReciprocal() && C->isNormalFP())))
1206     return nullptr;
1207 
1208   // Disallow denormal constants because we don't know what would happen
1209   // on all targets.
1210   // TODO: Use Intrinsic::canonicalize or let function attributes tell us that
1211   // denorms are flushed?
1212   auto *RecipC = ConstantExpr::getFDiv(ConstantFP::get(I.getType(), 1.0), C);
1213   if (!RecipC->isNormalFP())
1214     return nullptr;
1215 
1216   // X / C --> X * (1 / C)
1217   return BinaryOperator::CreateFMulFMF(I.getOperand(0), RecipC, &I);
1218 }
1219 
1220 /// Remove negation and try to reassociate constant math.
1221 static Instruction *foldFDivConstantDividend(BinaryOperator &I) {
1222   Constant *C;
1223   if (!match(I.getOperand(0), m_Constant(C)))
1224     return nullptr;
1225 
1226   // C / -X --> -C / X
1227   Value *X;
1228   if (match(I.getOperand(1), m_FNeg(m_Value(X))))
1229     return BinaryOperator::CreateFDivFMF(ConstantExpr::getFNeg(C), X, &I);
1230 
1231   if (!I.hasAllowReassoc() || !I.hasAllowReciprocal())
1232     return nullptr;
1233 
1234   // Try to reassociate C / X expressions where X includes another constant.
1235   Constant *C2, *NewC = nullptr;
1236   if (match(I.getOperand(1), m_FMul(m_Value(X), m_Constant(C2)))) {
1237     // C / (X * C2) --> (C / C2) / X
1238     NewC = ConstantExpr::getFDiv(C, C2);
1239   } else if (match(I.getOperand(1), m_FDiv(m_Value(X), m_Constant(C2)))) {
1240     // C / (X / C2) --> (C * C2) / X
1241     NewC = ConstantExpr::getFMul(C, C2);
1242   }
1243   // Disallow denormal constants because we don't know what would happen
1244   // on all targets.
1245   // TODO: Use Intrinsic::canonicalize or let function attributes tell us that
1246   // denorms are flushed?
1247   if (!NewC || !NewC->isNormalFP())
1248     return nullptr;
1249 
1250   return BinaryOperator::CreateFDivFMF(NewC, X, &I);
1251 }
1252 
1253 /// Negate the exponent of pow/exp to fold division-by-pow() into multiply.
1254 static Instruction *foldFDivPowDivisor(BinaryOperator &I,
1255                                        InstCombiner::BuilderTy &Builder) {
1256   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1257   auto *II = dyn_cast<IntrinsicInst>(Op1);
1258   if (!II || !II->hasOneUse() || !I.hasAllowReassoc() ||
1259       !I.hasAllowReciprocal())
1260     return nullptr;
1261 
1262   // Z / pow(X, Y) --> Z * pow(X, -Y)
1263   // Z / exp{2}(Y) --> Z * exp{2}(-Y)
1264   // In the general case, this creates an extra instruction, but fmul allows
1265   // for better canonicalization and optimization than fdiv.
1266   Intrinsic::ID IID = II->getIntrinsicID();
1267   SmallVector<Value *> Args;
1268   switch (IID) {
1269   case Intrinsic::pow:
1270     Args.push_back(II->getArgOperand(0));
1271     Args.push_back(Builder.CreateFNegFMF(II->getArgOperand(1), &I));
1272     break;
1273   case Intrinsic::powi: {
1274     // Require 'ninf' assuming that makes powi(X, -INT_MIN) acceptable.
1275     // That is, X ** (huge negative number) is 0.0, ~1.0, or INF and so
1276     // dividing by that is INF, ~1.0, or 0.0. Code that uses powi allows
1277     // non-standard results, so this corner case should be acceptable if the
1278     // code rules out INF values.
1279     if (!I.hasNoInfs())
1280       return nullptr;
1281     Args.push_back(II->getArgOperand(0));
1282     Args.push_back(Builder.CreateNeg(II->getArgOperand(1)));
1283     Type *Tys[] = {I.getType(), II->getArgOperand(1)->getType()};
1284     Value *Pow = Builder.CreateIntrinsic(IID, Tys, Args, &I);
1285     return BinaryOperator::CreateFMulFMF(Op0, Pow, &I);
1286   }
1287   case Intrinsic::exp:
1288   case Intrinsic::exp2:
1289     Args.push_back(Builder.CreateFNegFMF(II->getArgOperand(0), &I));
1290     break;
1291   default:
1292     return nullptr;
1293   }
1294   Value *Pow = Builder.CreateIntrinsic(IID, I.getType(), Args, &I);
1295   return BinaryOperator::CreateFMulFMF(Op0, Pow, &I);
1296 }
1297 
1298 Instruction *InstCombinerImpl::visitFDiv(BinaryOperator &I) {
1299   Module *M = I.getModule();
1300 
1301   if (Value *V = SimplifyFDivInst(I.getOperand(0), I.getOperand(1),
1302                                   I.getFastMathFlags(),
1303                                   SQ.getWithInstruction(&I)))
1304     return replaceInstUsesWith(I, V);
1305 
1306   if (Instruction *X = foldVectorBinop(I))
1307     return X;
1308 
1309   if (Instruction *Phi = foldBinopWithPhiOperands(I))
1310     return Phi;
1311 
1312   if (Instruction *R = foldFDivConstantDivisor(I))
1313     return R;
1314 
1315   if (Instruction *R = foldFDivConstantDividend(I))
1316     return R;
1317 
1318   if (Instruction *R = foldFPSignBitOps(I))
1319     return R;
1320 
1321   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1322   if (isa<Constant>(Op0))
1323     if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
1324       if (Instruction *R = FoldOpIntoSelect(I, SI))
1325         return R;
1326 
1327   if (isa<Constant>(Op1))
1328     if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
1329       if (Instruction *R = FoldOpIntoSelect(I, SI))
1330         return R;
1331 
1332   if (I.hasAllowReassoc() && I.hasAllowReciprocal()) {
1333     Value *X, *Y;
1334     if (match(Op0, m_OneUse(m_FDiv(m_Value(X), m_Value(Y)))) &&
1335         (!isa<Constant>(Y) || !isa<Constant>(Op1))) {
1336       // (X / Y) / Z => X / (Y * Z)
1337       Value *YZ = Builder.CreateFMulFMF(Y, Op1, &I);
1338       return BinaryOperator::CreateFDivFMF(X, YZ, &I);
1339     }
1340     if (match(Op1, m_OneUse(m_FDiv(m_Value(X), m_Value(Y)))) &&
1341         (!isa<Constant>(Y) || !isa<Constant>(Op0))) {
1342       // Z / (X / Y) => (Y * Z) / X
1343       Value *YZ = Builder.CreateFMulFMF(Y, Op0, &I);
1344       return BinaryOperator::CreateFDivFMF(YZ, X, &I);
1345     }
1346     // Z / (1.0 / Y) => (Y * Z)
1347     //
1348     // This is a special case of Z / (X / Y) => (Y * Z) / X, with X = 1.0. The
1349     // m_OneUse check is avoided because even in the case of the multiple uses
1350     // for 1.0/Y, the number of instructions remain the same and a division is
1351     // replaced by a multiplication.
1352     if (match(Op1, m_FDiv(m_SpecificFP(1.0), m_Value(Y))))
1353       return BinaryOperator::CreateFMulFMF(Y, Op0, &I);
1354   }
1355 
1356   if (I.hasAllowReassoc() && Op0->hasOneUse() && Op1->hasOneUse()) {
1357     // sin(X) / cos(X) -> tan(X)
1358     // cos(X) / sin(X) -> 1/tan(X) (cotangent)
1359     Value *X;
1360     bool IsTan = match(Op0, m_Intrinsic<Intrinsic::sin>(m_Value(X))) &&
1361                  match(Op1, m_Intrinsic<Intrinsic::cos>(m_Specific(X)));
1362     bool IsCot =
1363         !IsTan && match(Op0, m_Intrinsic<Intrinsic::cos>(m_Value(X))) &&
1364                   match(Op1, m_Intrinsic<Intrinsic::sin>(m_Specific(X)));
1365 
1366     if ((IsTan || IsCot) && hasFloatFn(M, &TLI, I.getType(), LibFunc_tan,
1367                                        LibFunc_tanf, LibFunc_tanl)) {
1368       IRBuilder<> B(&I);
1369       IRBuilder<>::FastMathFlagGuard FMFGuard(B);
1370       B.setFastMathFlags(I.getFastMathFlags());
1371       AttributeList Attrs =
1372           cast<CallBase>(Op0)->getCalledFunction()->getAttributes();
1373       Value *Res = emitUnaryFloatFnCall(X, &TLI, LibFunc_tan, LibFunc_tanf,
1374                                         LibFunc_tanl, B, Attrs);
1375       if (IsCot)
1376         Res = B.CreateFDiv(ConstantFP::get(I.getType(), 1.0), Res);
1377       return replaceInstUsesWith(I, Res);
1378     }
1379   }
1380 
1381   // X / (X * Y) --> 1.0 / Y
1382   // Reassociate to (X / X -> 1.0) is legal when NaNs are not allowed.
1383   // We can ignore the possibility that X is infinity because INF/INF is NaN.
1384   Value *X, *Y;
1385   if (I.hasNoNaNs() && I.hasAllowReassoc() &&
1386       match(Op1, m_c_FMul(m_Specific(Op0), m_Value(Y)))) {
1387     replaceOperand(I, 0, ConstantFP::get(I.getType(), 1.0));
1388     replaceOperand(I, 1, Y);
1389     return &I;
1390   }
1391 
1392   // X / fabs(X) -> copysign(1.0, X)
1393   // fabs(X) / X -> copysign(1.0, X)
1394   if (I.hasNoNaNs() && I.hasNoInfs() &&
1395       (match(&I, m_FDiv(m_Value(X), m_FAbs(m_Deferred(X)))) ||
1396        match(&I, m_FDiv(m_FAbs(m_Value(X)), m_Deferred(X))))) {
1397     Value *V = Builder.CreateBinaryIntrinsic(
1398         Intrinsic::copysign, ConstantFP::get(I.getType(), 1.0), X, &I);
1399     return replaceInstUsesWith(I, V);
1400   }
1401 
1402   if (Instruction *Mul = foldFDivPowDivisor(I, Builder))
1403     return Mul;
1404 
1405   return nullptr;
1406 }
1407 
1408 /// This function implements the transforms common to both integer remainder
1409 /// instructions (urem and srem). It is called by the visitors to those integer
1410 /// remainder instructions.
1411 /// Common integer remainder transforms
1412 Instruction *InstCombinerImpl::commonIRemTransforms(BinaryOperator &I) {
1413   if (Instruction *Phi = foldBinopWithPhiOperands(I))
1414     return Phi;
1415 
1416   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1417 
1418   // The RHS is known non-zero.
1419   if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I))
1420     return replaceOperand(I, 1, V);
1421 
1422   // Handle cases involving: rem X, (select Cond, Y, Z)
1423   if (simplifyDivRemOfSelectWithZeroOp(I))
1424     return &I;
1425 
1426   // If the divisor is a select-of-constants, try to constant fold all rem ops:
1427   // C % (select Cond, TrueC, FalseC) --> select Cond, (C % TrueC), (C % FalseC)
1428   // TODO: Adapt simplifyDivRemOfSelectWithZeroOp to allow this and other folds.
1429   if (match(Op0, m_ImmConstant()) &&
1430       match(Op1, m_Select(m_Value(), m_ImmConstant(), m_ImmConstant()))) {
1431     if (Instruction *R = FoldOpIntoSelect(I, cast<SelectInst>(Op1),
1432                                           /*FoldWithMultiUse*/ true))
1433       return R;
1434   }
1435 
1436   if (isa<Constant>(Op1)) {
1437     if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
1438       if (SelectInst *SI = dyn_cast<SelectInst>(Op0I)) {
1439         if (Instruction *R = FoldOpIntoSelect(I, SI))
1440           return R;
1441       } else if (auto *PN = dyn_cast<PHINode>(Op0I)) {
1442         const APInt *Op1Int;
1443         if (match(Op1, m_APInt(Op1Int)) && !Op1Int->isMinValue() &&
1444             (I.getOpcode() == Instruction::URem ||
1445              !Op1Int->isMinSignedValue())) {
1446           // foldOpIntoPhi will speculate instructions to the end of the PHI's
1447           // predecessor blocks, so do this only if we know the srem or urem
1448           // will not fault.
1449           if (Instruction *NV = foldOpIntoPhi(I, PN))
1450             return NV;
1451         }
1452       }
1453 
1454       // See if we can fold away this rem instruction.
1455       if (SimplifyDemandedInstructionBits(I))
1456         return &I;
1457     }
1458   }
1459 
1460   return nullptr;
1461 }
1462 
1463 Instruction *InstCombinerImpl::visitURem(BinaryOperator &I) {
1464   if (Value *V = SimplifyURemInst(I.getOperand(0), I.getOperand(1),
1465                                   SQ.getWithInstruction(&I)))
1466     return replaceInstUsesWith(I, V);
1467 
1468   if (Instruction *X = foldVectorBinop(I))
1469     return X;
1470 
1471   if (Instruction *common = commonIRemTransforms(I))
1472     return common;
1473 
1474   if (Instruction *NarrowRem = narrowUDivURem(I, Builder))
1475     return NarrowRem;
1476 
1477   // X urem Y -> X and Y-1, where Y is a power of 2,
1478   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1479   Type *Ty = I.getType();
1480   if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/ true, 0, &I)) {
1481     // This may increase instruction count, we don't enforce that Y is a
1482     // constant.
1483     Constant *N1 = Constant::getAllOnesValue(Ty);
1484     Value *Add = Builder.CreateAdd(Op1, N1);
1485     return BinaryOperator::CreateAnd(Op0, Add);
1486   }
1487 
1488   // 1 urem X -> zext(X != 1)
1489   if (match(Op0, m_One())) {
1490     Value *Cmp = Builder.CreateICmpNE(Op1, ConstantInt::get(Ty, 1));
1491     return CastInst::CreateZExtOrBitCast(Cmp, Ty);
1492   }
1493 
1494   // Op0 urem C -> Op0 < C ? Op0 : Op0 - C, where C >= signbit.
1495   // Op0 must be frozen because we are increasing its number of uses.
1496   if (match(Op1, m_Negative())) {
1497     Value *F0 = Builder.CreateFreeze(Op0, Op0->getName() + ".fr");
1498     Value *Cmp = Builder.CreateICmpULT(F0, Op1);
1499     Value *Sub = Builder.CreateSub(F0, Op1);
1500     return SelectInst::Create(Cmp, F0, Sub);
1501   }
1502 
1503   // If the divisor is a sext of a boolean, then the divisor must be max
1504   // unsigned value (-1). Therefore, the remainder is Op0 unless Op0 is also
1505   // max unsigned value. In that case, the remainder is 0:
1506   // urem Op0, (sext i1 X) --> (Op0 == -1) ? 0 : Op0
1507   Value *X;
1508   if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)) {
1509     Value *Cmp = Builder.CreateICmpEQ(Op0, ConstantInt::getAllOnesValue(Ty));
1510     return SelectInst::Create(Cmp, ConstantInt::getNullValue(Ty), Op0);
1511   }
1512 
1513   return nullptr;
1514 }
1515 
1516 Instruction *InstCombinerImpl::visitSRem(BinaryOperator &I) {
1517   if (Value *V = SimplifySRemInst(I.getOperand(0), I.getOperand(1),
1518                                   SQ.getWithInstruction(&I)))
1519     return replaceInstUsesWith(I, V);
1520 
1521   if (Instruction *X = foldVectorBinop(I))
1522     return X;
1523 
1524   // Handle the integer rem common cases
1525   if (Instruction *Common = commonIRemTransforms(I))
1526     return Common;
1527 
1528   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1529   {
1530     const APInt *Y;
1531     // X % -Y -> X % Y
1532     if (match(Op1, m_Negative(Y)) && !Y->isMinSignedValue())
1533       return replaceOperand(I, 1, ConstantInt::get(I.getType(), -*Y));
1534   }
1535 
1536   // -X srem Y --> -(X srem Y)
1537   Value *X, *Y;
1538   if (match(&I, m_SRem(m_OneUse(m_NSWSub(m_Zero(), m_Value(X))), m_Value(Y))))
1539     return BinaryOperator::CreateNSWNeg(Builder.CreateSRem(X, Y));
1540 
1541   // If the sign bits of both operands are zero (i.e. we can prove they are
1542   // unsigned inputs), turn this into a urem.
1543   APInt Mask(APInt::getSignMask(I.getType()->getScalarSizeInBits()));
1544   if (MaskedValueIsZero(Op1, Mask, 0, &I) &&
1545       MaskedValueIsZero(Op0, Mask, 0, &I)) {
1546     // X srem Y -> X urem Y, iff X and Y don't have sign bit set
1547     return BinaryOperator::CreateURem(Op0, Op1, I.getName());
1548   }
1549 
1550   // If it's a constant vector, flip any negative values positive.
1551   if (isa<ConstantVector>(Op1) || isa<ConstantDataVector>(Op1)) {
1552     Constant *C = cast<Constant>(Op1);
1553     unsigned VWidth = cast<FixedVectorType>(C->getType())->getNumElements();
1554 
1555     bool hasNegative = false;
1556     bool hasMissing = false;
1557     for (unsigned i = 0; i != VWidth; ++i) {
1558       Constant *Elt = C->getAggregateElement(i);
1559       if (!Elt) {
1560         hasMissing = true;
1561         break;
1562       }
1563 
1564       if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elt))
1565         if (RHS->isNegative())
1566           hasNegative = true;
1567     }
1568 
1569     if (hasNegative && !hasMissing) {
1570       SmallVector<Constant *, 16> Elts(VWidth);
1571       for (unsigned i = 0; i != VWidth; ++i) {
1572         Elts[i] = C->getAggregateElement(i);  // Handle undef, etc.
1573         if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elts[i])) {
1574           if (RHS->isNegative())
1575             Elts[i] = cast<ConstantInt>(ConstantExpr::getNeg(RHS));
1576         }
1577       }
1578 
1579       Constant *NewRHSV = ConstantVector::get(Elts);
1580       if (NewRHSV != C)  // Don't loop on -MININT
1581         return replaceOperand(I, 1, NewRHSV);
1582     }
1583   }
1584 
1585   return nullptr;
1586 }
1587 
1588 Instruction *InstCombinerImpl::visitFRem(BinaryOperator &I) {
1589   if (Value *V = SimplifyFRemInst(I.getOperand(0), I.getOperand(1),
1590                                   I.getFastMathFlags(),
1591                                   SQ.getWithInstruction(&I)))
1592     return replaceInstUsesWith(I, V);
1593 
1594   if (Instruction *X = foldVectorBinop(I))
1595     return X;
1596 
1597   if (Instruction *Phi = foldBinopWithPhiOperands(I))
1598     return Phi;
1599 
1600   return nullptr;
1601 }
1602