1 //===- InstCombineMulDivRem.cpp -------------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the visit functions for mul, fmul, sdiv, udiv, fdiv,
13 //===----------------------------------------------------------------------===//
15 #include "InstCombine.h"
16 #include "llvm/Analysis/InstructionSimplify.h"
17 #include "llvm/IR/IntrinsicInst.h"
18 #include "llvm/Support/PatternMatch.h"
20 using namespace PatternMatch;
23 /// simplifyValueKnownNonZero - The specific integer value is used in a context
24 /// where it is known to be non-zero. If this allows us to simplify the
25 /// computation, do so and return the new operand, otherwise return null.
26 static Value *simplifyValueKnownNonZero(Value *V, InstCombiner &IC) {
27 // If V has multiple uses, then we would have to do more analysis to determine
28 // if this is safe. For example, the use could be in dynamically unreached
30 if (!V->hasOneUse()) return 0;
32 bool MadeChange = false;
34 // ((1 << A) >>u B) --> (1 << (A-B))
35 // Because V cannot be zero, we know that B is less than A.
36 Value *A = 0, *B = 0, *PowerOf2 = 0;
37 if (match(V, m_LShr(m_OneUse(m_Shl(m_Value(PowerOf2), m_Value(A))),
39 // The "1" can be any value known to be a power of 2.
40 isKnownToBeAPowerOfTwo(PowerOf2)) {
41 A = IC.Builder->CreateSub(A, B);
42 return IC.Builder->CreateShl(PowerOf2, A);
45 // (PowerOfTwo >>u B) --> isExact since shifting out the result would make it
46 // inexact. Similarly for <<.
47 if (BinaryOperator *I = dyn_cast<BinaryOperator>(V))
48 if (I->isLogicalShift() && isKnownToBeAPowerOfTwo(I->getOperand(0))) {
49 // We know that this is an exact/nuw shift and that the input is a
50 // non-zero context as well.
51 if (Value *V2 = simplifyValueKnownNonZero(I->getOperand(0), IC)) {
56 if (I->getOpcode() == Instruction::LShr && !I->isExact()) {
61 if (I->getOpcode() == Instruction::Shl && !I->hasNoUnsignedWrap()) {
62 I->setHasNoUnsignedWrap();
67 // TODO: Lots more we could do here:
68 // If V is a phi node, we can call this on each of its operands.
69 // "select cond, X, 0" can simplify to "X".
71 return MadeChange ? V : 0;
75 /// MultiplyOverflows - True if the multiply can not be expressed in an int
77 static bool MultiplyOverflows(ConstantInt *C1, ConstantInt *C2, bool sign) {
78 uint32_t W = C1->getBitWidth();
79 APInt LHSExt = C1->getValue(), RHSExt = C2->getValue();
81 LHSExt = LHSExt.sext(W * 2);
82 RHSExt = RHSExt.sext(W * 2);
84 LHSExt = LHSExt.zext(W * 2);
85 RHSExt = RHSExt.zext(W * 2);
88 APInt MulExt = LHSExt * RHSExt;
91 return MulExt.ugt(APInt::getLowBitsSet(W * 2, W));
93 APInt Min = APInt::getSignedMinValue(W).sext(W * 2);
94 APInt Max = APInt::getSignedMaxValue(W).sext(W * 2);
95 return MulExt.slt(Min) || MulExt.sgt(Max);
98 Instruction *InstCombiner::visitMul(BinaryOperator &I) {
99 bool Changed = SimplifyAssociativeOrCommutative(I);
100 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
102 if (Value *V = SimplifyMulInst(Op0, Op1, TD))
103 return ReplaceInstUsesWith(I, V);
105 if (Value *V = SimplifyUsingDistributiveLaws(I))
106 return ReplaceInstUsesWith(I, V);
108 if (match(Op1, m_AllOnes())) // X * -1 == 0 - X
109 return BinaryOperator::CreateNeg(Op0, I.getName());
111 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
113 // ((X << C1)*C2) == (X * (C2 << C1))
114 if (BinaryOperator *SI = dyn_cast<BinaryOperator>(Op0))
115 if (SI->getOpcode() == Instruction::Shl)
116 if (Constant *ShOp = dyn_cast<Constant>(SI->getOperand(1)))
117 return BinaryOperator::CreateMul(SI->getOperand(0),
118 ConstantExpr::getShl(CI, ShOp));
120 const APInt &Val = CI->getValue();
121 if (Val.isPowerOf2()) { // Replace X*(2^C) with X << C
122 Constant *NewCst = ConstantInt::get(Op0->getType(), Val.logBase2());
123 BinaryOperator *Shl = BinaryOperator::CreateShl(Op0, NewCst);
124 if (I.hasNoSignedWrap()) Shl->setHasNoSignedWrap();
125 if (I.hasNoUnsignedWrap()) Shl->setHasNoUnsignedWrap();
129 // Canonicalize (X+C1)*CI -> X*CI+C1*CI.
130 { Value *X; ConstantInt *C1;
131 if (Op0->hasOneUse() &&
132 match(Op0, m_Add(m_Value(X), m_ConstantInt(C1)))) {
133 Value *Add = Builder->CreateMul(X, CI);
134 return BinaryOperator::CreateAdd(Add, Builder->CreateMul(C1, CI));
138 // (Y - X) * (-(2**n)) -> (X - Y) * (2**n), for positive nonzero n
139 // (Y + const) * (-(2**n)) -> (-constY) * (2**n), for positive nonzero n
140 // The "* (2**n)" thus becomes a potential shifting opportunity.
142 const APInt & Val = CI->getValue();
143 const APInt &PosVal = Val.abs();
144 if (Val.isNegative() && PosVal.isPowerOf2()) {
145 Value *X = 0, *Y = 0;
146 if (Op0->hasOneUse()) {
149 if (match(Op0, m_Sub(m_Value(Y), m_Value(X))))
150 Sub = Builder->CreateSub(X, Y, "suba");
151 else if (match(Op0, m_Add(m_Value(Y), m_ConstantInt(C1))))
152 Sub = Builder->CreateSub(Builder->CreateNeg(C1), Y, "subc");
155 BinaryOperator::CreateMul(Sub,
156 ConstantInt::get(Y->getType(), PosVal));
162 // Simplify mul instructions with a constant RHS.
163 if (isa<Constant>(Op1)) {
164 // Try to fold constant mul into select arguments.
165 if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
166 if (Instruction *R = FoldOpIntoSelect(I, SI))
169 if (isa<PHINode>(Op0))
170 if (Instruction *NV = FoldOpIntoPhi(I))
174 if (Value *Op0v = dyn_castNegVal(Op0)) // -X * -Y = X*Y
175 if (Value *Op1v = dyn_castNegVal(Op1))
176 return BinaryOperator::CreateMul(Op0v, Op1v);
178 // (X / Y) * Y = X - (X % Y)
179 // (X / Y) * -Y = (X % Y) - X
182 BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0);
184 (BO->getOpcode() != Instruction::UDiv &&
185 BO->getOpcode() != Instruction::SDiv)) {
187 BO = dyn_cast<BinaryOperator>(Op1);
189 Value *Neg = dyn_castNegVal(Op1C);
190 if (BO && BO->hasOneUse() &&
191 (BO->getOperand(1) == Op1C || BO->getOperand(1) == Neg) &&
192 (BO->getOpcode() == Instruction::UDiv ||
193 BO->getOpcode() == Instruction::SDiv)) {
194 Value *Op0BO = BO->getOperand(0), *Op1BO = BO->getOperand(1);
196 // If the division is exact, X % Y is zero, so we end up with X or -X.
197 if (PossiblyExactOperator *SDiv = dyn_cast<PossiblyExactOperator>(BO))
198 if (SDiv->isExact()) {
200 return ReplaceInstUsesWith(I, Op0BO);
201 return BinaryOperator::CreateNeg(Op0BO);
205 if (BO->getOpcode() == Instruction::UDiv)
206 Rem = Builder->CreateURem(Op0BO, Op1BO);
208 Rem = Builder->CreateSRem(Op0BO, Op1BO);
212 return BinaryOperator::CreateSub(Op0BO, Rem);
213 return BinaryOperator::CreateSub(Rem, Op0BO);
217 /// i1 mul -> i1 and.
218 if (I.getType()->isIntegerTy(1))
219 return BinaryOperator::CreateAnd(Op0, Op1);
221 // X*(1 << Y) --> X << Y
222 // (1 << Y)*X --> X << Y
225 if (match(Op0, m_Shl(m_One(), m_Value(Y))))
226 return BinaryOperator::CreateShl(Op1, Y);
227 if (match(Op1, m_Shl(m_One(), m_Value(Y))))
228 return BinaryOperator::CreateShl(Op0, Y);
231 // If one of the operands of the multiply is a cast from a boolean value, then
232 // we know the bool is either zero or one, so this is a 'masking' multiply.
233 // X * Y (where Y is 0 or 1) -> X & (0-Y)
234 if (!I.getType()->isVectorTy()) {
235 // -2 is "-1 << 1" so it is all bits set except the low one.
236 APInt Negative2(I.getType()->getPrimitiveSizeInBits(), (uint64_t)-2, true);
238 Value *BoolCast = 0, *OtherOp = 0;
239 if (MaskedValueIsZero(Op0, Negative2))
240 BoolCast = Op0, OtherOp = Op1;
241 else if (MaskedValueIsZero(Op1, Negative2))
242 BoolCast = Op1, OtherOp = Op0;
245 Value *V = Builder->CreateSub(Constant::getNullValue(I.getType()),
247 return BinaryOperator::CreateAnd(V, OtherOp);
251 return Changed ? &I : 0;
259 // And check for corresponding fast math flags
262 static void detectLog2OfHalf(Value *&Op, Value *&Y, IntrinsicInst *&Log2) {
264 if (!Op->hasOneUse())
267 IntrinsicInst *II = dyn_cast<IntrinsicInst>(Op);
270 if (II->getIntrinsicID() != Intrinsic::log2 || !II->hasUnsafeAlgebra())
274 Value *OpLog2Of = II->getArgOperand(0);
275 if (!OpLog2Of->hasOneUse())
278 Instruction *I = dyn_cast<Instruction>(OpLog2Of);
281 if (I->getOpcode() != Instruction::FMul || !I->hasUnsafeAlgebra())
284 ConstantFP *CFP = dyn_cast<ConstantFP>(I->getOperand(0));
285 if (CFP && CFP->isExactlyValue(0.5)) {
286 Y = I->getOperand(1);
289 CFP = dyn_cast<ConstantFP>(I->getOperand(1));
290 if (CFP && CFP->isExactlyValue(0.5))
291 Y = I->getOperand(0);
294 /// Helper function of InstCombiner::visitFMul(BinaryOperator(). It returns
295 /// true iff the given value is FMul or FDiv with one and only one operand
296 /// being a normal constant (i.e. not Zero/NaN/Infinity).
297 static bool isFMulOrFDivWithConstant(Value *V) {
298 Instruction *I = dyn_cast<Instruction>(V);
299 if (!I || (I->getOpcode() != Instruction::FMul &&
300 I->getOpcode() != Instruction::FDiv))
303 ConstantFP *C0 = dyn_cast<ConstantFP>(I->getOperand(0));
304 ConstantFP *C1 = dyn_cast<ConstantFP>(I->getOperand(1));
309 return (C0 && C0->getValueAPF().isNormal()) ||
310 (C1 && C1->getValueAPF().isNormal());
313 static bool isNormalFp(const ConstantFP *C) {
314 const APFloat &Flt = C->getValueAPF();
315 return Flt.isNormal() && !Flt.isDenormal();
318 /// foldFMulConst() is a helper routine of InstCombiner::visitFMul().
319 /// The input \p FMulOrDiv is a FMul/FDiv with one and only one operand
320 /// being a constant (i.e. isFMulOrFDivWithConstant(FMulOrDiv) == true).
321 /// This function is to simplify "FMulOrDiv * C" and returns the
322 /// resulting expression. Note that this function could return NULL in
323 /// case the constants cannot be folded into a normal floating-point.
325 Value *InstCombiner::foldFMulConst(Instruction *FMulOrDiv, ConstantFP *C,
326 Instruction *InsertBefore) {
327 assert(isFMulOrFDivWithConstant(FMulOrDiv) && "V is invalid");
329 Value *Opnd0 = FMulOrDiv->getOperand(0);
330 Value *Opnd1 = FMulOrDiv->getOperand(1);
332 ConstantFP *C0 = dyn_cast<ConstantFP>(Opnd0);
333 ConstantFP *C1 = dyn_cast<ConstantFP>(Opnd1);
335 BinaryOperator *R = 0;
337 // (X * C0) * C => X * (C0*C)
338 if (FMulOrDiv->getOpcode() == Instruction::FMul) {
339 Constant *F = ConstantExpr::getFMul(C1 ? C1 : C0, C);
340 if (isNormalFp(cast<ConstantFP>(F)))
341 R = BinaryOperator::CreateFMul(C1 ? Opnd0 : Opnd1, F);
344 // (C0 / X) * C => (C0 * C) / X
345 ConstantFP *F = cast<ConstantFP>(ConstantExpr::getFMul(C0, C));
347 R = BinaryOperator::CreateFDiv(F, Opnd1);
349 // (X / C1) * C => X * (C/C1) if C/C1 is not a denormal
350 ConstantFP *F = cast<ConstantFP>(ConstantExpr::getFDiv(C, C1));
352 R = BinaryOperator::CreateFMul(Opnd0, F);
354 // (X / C1) * C => X / (C1/C)
355 Constant *F = ConstantExpr::getFDiv(C1, C);
356 if (isNormalFp(cast<ConstantFP>(F)))
357 R = BinaryOperator::CreateFDiv(Opnd0, F);
363 R->setHasUnsafeAlgebra(true);
364 InsertNewInstWith(R, *InsertBefore);
370 Instruction *InstCombiner::visitFMul(BinaryOperator &I) {
371 bool Changed = SimplifyAssociativeOrCommutative(I);
372 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
374 if (isa<Constant>(Op0))
377 if (Value *V = SimplifyFMulInst(Op0, Op1, I.getFastMathFlags(), TD))
378 return ReplaceInstUsesWith(I, V);
380 // Simplify mul instructions with a constant RHS.
381 if (isa<Constant>(Op1)) {
382 // Try to fold constant mul into select arguments.
383 if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
384 if (Instruction *R = FoldOpIntoSelect(I, SI))
387 if (isa<PHINode>(Op0))
388 if (Instruction *NV = FoldOpIntoPhi(I))
391 ConstantFP *C = dyn_cast<ConstantFP>(Op1);
392 if (C && I.hasUnsafeAlgebra() && C->getValueAPF().isNormal()) {
393 // Let MDC denote an expression in one of these forms:
394 // X * C, C/X, X/C, where C is a constant.
396 // Try to simplify "MDC * Constant"
397 if (isFMulOrFDivWithConstant(Op0)) {
398 Value *V = foldFMulConst(cast<Instruction>(Op0), C, &I);
400 return ReplaceInstUsesWith(I, V);
403 // (MDC +/- C1) * C2 => (MDC * C2) +/- (C1 * C2)
404 Instruction *FAddSub = dyn_cast<Instruction>(Op0);
406 (FAddSub->getOpcode() == Instruction::FAdd ||
407 FAddSub->getOpcode() == Instruction::FSub)) {
408 Value *Opnd0 = FAddSub->getOperand(0);
409 Value *Opnd1 = FAddSub->getOperand(1);
410 ConstantFP *C0 = dyn_cast<ConstantFP>(Opnd0);
411 ConstantFP *C1 = dyn_cast<ConstantFP>(Opnd1);
415 std::swap(Opnd0, Opnd1);
419 if (C1 && C1->getValueAPF().isNormal() &&
420 isFMulOrFDivWithConstant(Opnd0)) {
421 Value *M0 = ConstantExpr::getFMul(C1, C);
422 Value *M1 = isNormalFp(cast<ConstantFP>(M0)) ?
423 foldFMulConst(cast<Instruction>(Opnd0), C, &I) :
426 if (Swap && FAddSub->getOpcode() == Instruction::FSub)
429 Value *R = (FAddSub->getOpcode() == Instruction::FAdd) ?
430 BinaryOperator::CreateFAdd(M0, M1) :
431 BinaryOperator::CreateFSub(M0, M1);
432 Instruction *RI = cast<Instruction>(R);
433 RI->setHasUnsafeAlgebra(true);
441 if (Value *Op0v = dyn_castFNegVal(Op0)) // -X * -Y = X*Y
442 if (Value *Op1v = dyn_castFNegVal(Op1))
443 return BinaryOperator::CreateFMul(Op0v, Op1v);
445 // Under unsafe algebra do:
446 // X * log2(0.5*Y) = X*log2(Y) - X
447 if (I.hasUnsafeAlgebra()) {
451 detectLog2OfHalf(Op0, OpY, Log2);
455 detectLog2OfHalf(Op1, OpY, Log2);
460 // if pattern detected emit alternate sequence
462 Log2->setArgOperand(0, OpY);
463 Value *FMulVal = Builder->CreateFMul(OpX, Log2);
464 Instruction *FMul = cast<Instruction>(FMulVal);
465 FMul->copyFastMathFlags(Log2);
466 Instruction *FSub = BinaryOperator::CreateFSub(FMulVal, OpX);
467 FSub->copyFastMathFlags(Log2);
472 // X * cond ? 1.0 : 0.0 => cond ? X : 0.0
473 if (I.hasNoNaNs() && I.hasNoSignedZeros()) {
474 Value *V0 = I.getOperand(0);
475 Value *V1 = I.getOperand(1);
476 Value *Cond, *SLHS, *SRHS;
479 if (match(V0, m_Select(m_Value(Cond), m_Value(SLHS), m_Value(SRHS)))) {
481 } else if (match(V1, m_Select(m_Value(Cond), m_Value(SLHS),
488 ConstantFP *C0 = dyn_cast<ConstantFP>(SLHS);
489 ConstantFP *C1 = dyn_cast<ConstantFP>(SRHS);
492 ((C0->isZero() && C1->isExactlyValue(1.0)) ||
493 (C1->isZero() && C0->isExactlyValue(1.0)))) {
496 T = Builder->CreateSelect(Cond, SLHS, V1);
498 T = Builder->CreateSelect(Cond, V1, SRHS);
499 return ReplaceInstUsesWith(I, T);
504 return Changed ? &I : 0;
507 /// SimplifyDivRemOfSelect - Try to fold a divide or remainder of a select
509 bool InstCombiner::SimplifyDivRemOfSelect(BinaryOperator &I) {
510 SelectInst *SI = cast<SelectInst>(I.getOperand(1));
512 // div/rem X, (Cond ? 0 : Y) -> div/rem X, Y
513 int NonNullOperand = -1;
514 if (Constant *ST = dyn_cast<Constant>(SI->getOperand(1)))
515 if (ST->isNullValue())
517 // div/rem X, (Cond ? Y : 0) -> div/rem X, Y
518 if (Constant *ST = dyn_cast<Constant>(SI->getOperand(2)))
519 if (ST->isNullValue())
522 if (NonNullOperand == -1)
525 Value *SelectCond = SI->getOperand(0);
527 // Change the div/rem to use 'Y' instead of the select.
528 I.setOperand(1, SI->getOperand(NonNullOperand));
530 // Okay, we know we replace the operand of the div/rem with 'Y' with no
531 // problem. However, the select, or the condition of the select may have
532 // multiple uses. Based on our knowledge that the operand must be non-zero,
533 // propagate the known value for the select into other uses of it, and
534 // propagate a known value of the condition into its other users.
536 // If the select and condition only have a single use, don't bother with this,
538 if (SI->use_empty() && SelectCond->hasOneUse())
541 // Scan the current block backward, looking for other uses of SI.
542 BasicBlock::iterator BBI = &I, BBFront = I.getParent()->begin();
544 while (BBI != BBFront) {
546 // If we found a call to a function, we can't assume it will return, so
547 // information from below it cannot be propagated above it.
548 if (isa<CallInst>(BBI) && !isa<IntrinsicInst>(BBI))
551 // Replace uses of the select or its condition with the known values.
552 for (Instruction::op_iterator I = BBI->op_begin(), E = BBI->op_end();
555 *I = SI->getOperand(NonNullOperand);
557 } else if (*I == SelectCond) {
558 *I = NonNullOperand == 1 ? ConstantInt::getTrue(BBI->getContext()) :
559 ConstantInt::getFalse(BBI->getContext());
564 // If we past the instruction, quit looking for it.
567 if (&*BBI == SelectCond)
570 // If we ran out of things to eliminate, break out of the loop.
571 if (SelectCond == 0 && SI == 0)
579 /// This function implements the transforms common to both integer division
580 /// instructions (udiv and sdiv). It is called by the visitors to those integer
581 /// division instructions.
582 /// @brief Common integer divide transforms
583 Instruction *InstCombiner::commonIDivTransforms(BinaryOperator &I) {
584 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
586 // The RHS is known non-zero.
587 if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this)) {
592 // Handle cases involving: [su]div X, (select Cond, Y, Z)
593 // This does not apply for fdiv.
594 if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
597 if (ConstantInt *RHS = dyn_cast<ConstantInt>(Op1)) {
598 // (X / C1) / C2 -> X / (C1*C2)
599 if (Instruction *LHS = dyn_cast<Instruction>(Op0))
600 if (Instruction::BinaryOps(LHS->getOpcode()) == I.getOpcode())
601 if (ConstantInt *LHSRHS = dyn_cast<ConstantInt>(LHS->getOperand(1))) {
602 if (MultiplyOverflows(RHS, LHSRHS,
603 I.getOpcode()==Instruction::SDiv))
604 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
605 return BinaryOperator::Create(I.getOpcode(), LHS->getOperand(0),
606 ConstantExpr::getMul(RHS, LHSRHS));
609 if (!RHS->isZero()) { // avoid X udiv 0
610 if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
611 if (Instruction *R = FoldOpIntoSelect(I, SI))
613 if (isa<PHINode>(Op0))
614 if (Instruction *NV = FoldOpIntoPhi(I))
619 // See if we can fold away this div instruction.
620 if (SimplifyDemandedInstructionBits(I))
623 // (X - (X rem Y)) / Y -> X / Y; usually originates as ((X / Y) * Y) / Y
624 Value *X = 0, *Z = 0;
625 if (match(Op0, m_Sub(m_Value(X), m_Value(Z)))) { // (X - Z) / Y; Y = Op1
626 bool isSigned = I.getOpcode() == Instruction::SDiv;
627 if ((isSigned && match(Z, m_SRem(m_Specific(X), m_Specific(Op1)))) ||
628 (!isSigned && match(Z, m_URem(m_Specific(X), m_Specific(Op1)))))
629 return BinaryOperator::Create(I.getOpcode(), X, Op1);
635 /// dyn_castZExtVal - Checks if V is a zext or constant that can
636 /// be truncated to Ty without losing bits.
637 static Value *dyn_castZExtVal(Value *V, Type *Ty) {
638 if (ZExtInst *Z = dyn_cast<ZExtInst>(V)) {
639 if (Z->getSrcTy() == Ty)
640 return Z->getOperand(0);
641 } else if (ConstantInt *C = dyn_cast<ConstantInt>(V)) {
642 if (C->getValue().getActiveBits() <= cast<IntegerType>(Ty)->getBitWidth())
643 return ConstantExpr::getTrunc(C, Ty);
648 Instruction *InstCombiner::visitUDiv(BinaryOperator &I) {
649 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
651 if (Value *V = SimplifyUDivInst(Op0, Op1, TD))
652 return ReplaceInstUsesWith(I, V);
654 // Handle the integer div common cases
655 if (Instruction *Common = commonIDivTransforms(I))
659 // X udiv 2^C -> X >> C
660 // Check to see if this is an unsigned division with an exact power of 2,
661 // if so, convert to a right shift.
663 if (match(Op1, m_Power2(C))) {
664 BinaryOperator *LShr =
665 BinaryOperator::CreateLShr(Op0,
666 ConstantInt::get(Op0->getType(),
668 if (I.isExact()) LShr->setIsExact();
673 if (ConstantInt *C = dyn_cast<ConstantInt>(Op1)) {
674 // X udiv C, where C >= signbit
675 if (C->getValue().isNegative()) {
676 Value *IC = Builder->CreateICmpULT(Op0, C);
677 return SelectInst::Create(IC, Constant::getNullValue(I.getType()),
678 ConstantInt::get(I.getType(), 1));
682 // (x lshr C1) udiv C2 --> x udiv (C2 << C1)
683 if (ConstantInt *C2 = dyn_cast<ConstantInt>(Op1)) {
686 if (match(Op0, m_LShr(m_Value(X), m_ConstantInt(C1)))) {
687 APInt NC = C2->getValue().shl(C1->getLimitedValue(C1->getBitWidth()-1));
688 return BinaryOperator::CreateUDiv(X, Builder->getInt(NC));
692 // X udiv (C1 << N), where C1 is "1<<C2" --> X >> (N+C2)
693 { const APInt *CI; Value *N;
694 if (match(Op1, m_Shl(m_Power2(CI), m_Value(N))) ||
695 match(Op1, m_ZExt(m_Shl(m_Power2(CI), m_Value(N))))) {
697 N = Builder->CreateAdd(N,
698 ConstantInt::get(N->getType(), CI->logBase2()));
699 if (ZExtInst *Z = dyn_cast<ZExtInst>(Op1))
700 N = Builder->CreateZExt(N, Z->getDestTy());
702 return BinaryOperator::CreateExactLShr(Op0, N);
703 return BinaryOperator::CreateLShr(Op0, N);
707 // udiv X, (Select Cond, C1, C2) --> Select Cond, (shr X, C1), (shr X, C2)
708 // where C1&C2 are powers of two.
709 { Value *Cond; const APInt *C1, *C2;
710 if (match(Op1, m_Select(m_Value(Cond), m_Power2(C1), m_Power2(C2)))) {
711 // Construct the "on true" case of the select
712 Value *TSI = Builder->CreateLShr(Op0, C1->logBase2(), Op1->getName()+".t",
715 // Construct the "on false" case of the select
716 Value *FSI = Builder->CreateLShr(Op0, C2->logBase2(), Op1->getName()+".f",
719 // construct the select instruction and return it.
720 return SelectInst::Create(Cond, TSI, FSI);
724 // (zext A) udiv (zext B) --> zext (A udiv B)
725 if (ZExtInst *ZOp0 = dyn_cast<ZExtInst>(Op0))
726 if (Value *ZOp1 = dyn_castZExtVal(Op1, ZOp0->getSrcTy()))
727 return new ZExtInst(Builder->CreateUDiv(ZOp0->getOperand(0), ZOp1, "div",
734 Instruction *InstCombiner::visitSDiv(BinaryOperator &I) {
735 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
737 if (Value *V = SimplifySDivInst(Op0, Op1, TD))
738 return ReplaceInstUsesWith(I, V);
740 // Handle the integer div common cases
741 if (Instruction *Common = commonIDivTransforms(I))
744 if (ConstantInt *RHS = dyn_cast<ConstantInt>(Op1)) {
746 if (RHS->isAllOnesValue())
747 return BinaryOperator::CreateNeg(Op0);
749 // sdiv X, C --> ashr exact X, log2(C)
750 if (I.isExact() && RHS->getValue().isNonNegative() &&
751 RHS->getValue().isPowerOf2()) {
752 Value *ShAmt = llvm::ConstantInt::get(RHS->getType(),
753 RHS->getValue().exactLogBase2());
754 return BinaryOperator::CreateExactAShr(Op0, ShAmt, I.getName());
757 // -X/C --> X/-C provided the negation doesn't overflow.
758 if (SubOperator *Sub = dyn_cast<SubOperator>(Op0))
759 if (match(Sub->getOperand(0), m_Zero()) && Sub->hasNoSignedWrap())
760 return BinaryOperator::CreateSDiv(Sub->getOperand(1),
761 ConstantExpr::getNeg(RHS));
764 // If the sign bits of both operands are zero (i.e. we can prove they are
765 // unsigned inputs), turn this into a udiv.
766 if (I.getType()->isIntegerTy()) {
767 APInt Mask(APInt::getSignBit(I.getType()->getPrimitiveSizeInBits()));
768 if (MaskedValueIsZero(Op0, Mask)) {
769 if (MaskedValueIsZero(Op1, Mask)) {
770 // X sdiv Y -> X udiv Y, iff X and Y don't have sign bit set
771 return BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
774 if (match(Op1, m_Shl(m_Power2(), m_Value()))) {
775 // X sdiv (1 << Y) -> X udiv (1 << Y) ( -> X u>> Y)
776 // Safe because the only negative value (1 << Y) can take on is
777 // INT_MIN, and X sdiv INT_MIN == X udiv INT_MIN == 0 if X doesn't have
779 return BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
787 /// CvtFDivConstToReciprocal tries to convert X/C into X*1/C if C not a special
789 /// 1) 1/C is exact, or
790 /// 2) reciprocal is allowed.
791 /// If the convertion was successful, the simplified expression "X * 1/C" is
792 /// returned; otherwise, NULL is returned.
794 static Instruction *CvtFDivConstToReciprocal(Value *Dividend,
796 bool AllowReciprocal) {
797 const APFloat &FpVal = Divisor->getValueAPF();
798 APFloat Reciprocal(FpVal.getSemantics());
799 bool Cvt = FpVal.getExactInverse(&Reciprocal);
801 if (!Cvt && AllowReciprocal && FpVal.isNormal()) {
802 Reciprocal = APFloat(FpVal.getSemantics(), 1.0f);
803 (void)Reciprocal.divide(FpVal, APFloat::rmNearestTiesToEven);
804 Cvt = !Reciprocal.isDenormal();
811 R = ConstantFP::get(Dividend->getType()->getContext(), Reciprocal);
812 return BinaryOperator::CreateFMul(Dividend, R);
815 Instruction *InstCombiner::visitFDiv(BinaryOperator &I) {
816 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
818 if (Value *V = SimplifyFDivInst(Op0, Op1, TD))
819 return ReplaceInstUsesWith(I, V);
821 bool AllowReassociate = I.hasUnsafeAlgebra();
822 bool AllowReciprocal = I.hasAllowReciprocal();
824 if (ConstantFP *Op1C = dyn_cast<ConstantFP>(Op1)) {
825 if (AllowReassociate) {
827 ConstantFP *C2 = Op1C;
829 Instruction *Res = 0;
831 if (match(Op0, m_FMul(m_Value(X), m_ConstantFP(C1)))) {
832 // (X*C1)/C2 => X * (C1/C2)
834 Constant *C = ConstantExpr::getFDiv(C1, C2);
835 const APFloat &F = cast<ConstantFP>(C)->getValueAPF();
836 if (F.isNormal() && !F.isDenormal())
837 Res = BinaryOperator::CreateFMul(X, C);
838 } else if (match(Op0, m_FDiv(m_Value(X), m_ConstantFP(C1)))) {
839 // (X/C1)/C2 => X /(C2*C1) [=> X * 1/(C2*C1) if reciprocal is allowed]
841 Constant *C = ConstantExpr::getFMul(C1, C2);
842 const APFloat &F = cast<ConstantFP>(C)->getValueAPF();
843 if (F.isNormal() && !F.isDenormal()) {
844 Res = CvtFDivConstToReciprocal(X, cast<ConstantFP>(C),
847 Res = BinaryOperator::CreateFDiv(X, C);
852 Res->setFastMathFlags(I.getFastMathFlags());
858 if (Instruction *T = CvtFDivConstToReciprocal(Op0, Op1C, AllowReciprocal))
864 if (AllowReassociate && isa<ConstantFP>(Op0)) {
865 ConstantFP *C1 = cast<ConstantFP>(Op0), *C2;
868 bool CreateDiv = true;
870 // C1 / (X*C2) => (C1/C2) / X
871 if (match(Op1, m_FMul(m_Value(X), m_ConstantFP(C2))))
872 Fold = ConstantExpr::getFDiv(C1, C2);
873 else if (match(Op1, m_FDiv(m_Value(X), m_ConstantFP(C2)))) {
874 // C1 / (X/C2) => (C1*C2) / X
875 Fold = ConstantExpr::getFMul(C1, C2);
876 } else if (match(Op1, m_FDiv(m_ConstantFP(C2), m_Value(X)))) {
877 // C1 / (C2/X) => (C1/C2) * X
878 Fold = ConstantExpr::getFDiv(C1, C2);
883 const APFloat &FoldC = cast<ConstantFP>(Fold)->getValueAPF();
884 if (FoldC.isNormal() && !FoldC.isDenormal()) {
885 Instruction *R = CreateDiv ?
886 BinaryOperator::CreateFDiv(Fold, X) :
887 BinaryOperator::CreateFMul(X, Fold);
888 R->setFastMathFlags(I.getFastMathFlags());
895 if (AllowReassociate) {
898 Instruction *SimpR = 0;
900 if (Op0->hasOneUse() && match(Op0, m_FDiv(m_Value(X), m_Value(Y)))) {
901 // (X/Y) / Z => X / (Y*Z)
903 if (!isa<ConstantFP>(Y) || !isa<ConstantFP>(Op1)) {
904 NewInst = Builder->CreateFMul(Y, Op1);
905 SimpR = BinaryOperator::CreateFDiv(X, NewInst);
907 } else if (Op1->hasOneUse() && match(Op1, m_FDiv(m_Value(X), m_Value(Y)))) {
908 // Z / (X/Y) => Z*Y / X
910 if (!isa<ConstantFP>(Y) || !isa<ConstantFP>(Op0)) {
911 NewInst = Builder->CreateFMul(Op0, Y);
912 SimpR = BinaryOperator::CreateFDiv(NewInst, X);
917 if (Instruction *T = dyn_cast<Instruction>(NewInst))
918 T->setDebugLoc(I.getDebugLoc());
919 SimpR->setFastMathFlags(I.getFastMathFlags());
927 /// This function implements the transforms common to both integer remainder
928 /// instructions (urem and srem). It is called by the visitors to those integer
929 /// remainder instructions.
930 /// @brief Common integer remainder transforms
931 Instruction *InstCombiner::commonIRemTransforms(BinaryOperator &I) {
932 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
934 // The RHS is known non-zero.
935 if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this)) {
940 // Handle cases involving: rem X, (select Cond, Y, Z)
941 if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
944 if (isa<ConstantInt>(Op1)) {
945 if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
946 if (SelectInst *SI = dyn_cast<SelectInst>(Op0I)) {
947 if (Instruction *R = FoldOpIntoSelect(I, SI))
949 } else if (isa<PHINode>(Op0I)) {
950 if (Instruction *NV = FoldOpIntoPhi(I))
954 // See if we can fold away this rem instruction.
955 if (SimplifyDemandedInstructionBits(I))
963 Instruction *InstCombiner::visitURem(BinaryOperator &I) {
964 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
966 if (Value *V = SimplifyURemInst(Op0, Op1, TD))
967 return ReplaceInstUsesWith(I, V);
969 if (Instruction *common = commonIRemTransforms(I))
972 // X urem C^2 -> X and C-1
974 if (match(Op1, m_Power2(C)))
975 return BinaryOperator::CreateAnd(Op0,
976 ConstantInt::get(I.getType(), *C-1));
979 // Turn A % (C << N), where C is 2^k, into A & ((C << N)-1)
980 if (match(Op1, m_Shl(m_Power2(), m_Value()))) {
981 Constant *N1 = Constant::getAllOnesValue(I.getType());
982 Value *Add = Builder->CreateAdd(Op1, N1);
983 return BinaryOperator::CreateAnd(Op0, Add);
986 // urem X, (select Cond, 2^C1, 2^C2) -->
987 // select Cond, (and X, C1-1), (and X, C2-1)
988 // when C1&C2 are powers of two.
989 { Value *Cond; const APInt *C1, *C2;
990 if (match(Op1, m_Select(m_Value(Cond), m_Power2(C1), m_Power2(C2)))) {
991 Value *TrueAnd = Builder->CreateAnd(Op0, *C1-1, Op1->getName()+".t");
992 Value *FalseAnd = Builder->CreateAnd(Op0, *C2-1, Op1->getName()+".f");
993 return SelectInst::Create(Cond, TrueAnd, FalseAnd);
997 // (zext A) urem (zext B) --> zext (A urem B)
998 if (ZExtInst *ZOp0 = dyn_cast<ZExtInst>(Op0))
999 if (Value *ZOp1 = dyn_castZExtVal(Op1, ZOp0->getSrcTy()))
1000 return new ZExtInst(Builder->CreateURem(ZOp0->getOperand(0), ZOp1),
1006 Instruction *InstCombiner::visitSRem(BinaryOperator &I) {
1007 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1009 if (Value *V = SimplifySRemInst(Op0, Op1, TD))
1010 return ReplaceInstUsesWith(I, V);
1012 // Handle the integer rem common cases
1013 if (Instruction *Common = commonIRemTransforms(I))
1016 if (Value *RHSNeg = dyn_castNegVal(Op1))
1017 if (!isa<Constant>(RHSNeg) ||
1018 (isa<ConstantInt>(RHSNeg) &&
1019 cast<ConstantInt>(RHSNeg)->getValue().isStrictlyPositive())) {
1021 Worklist.AddValue(I.getOperand(1));
1022 I.setOperand(1, RHSNeg);
1026 // If the sign bits of both operands are zero (i.e. we can prove they are
1027 // unsigned inputs), turn this into a urem.
1028 if (I.getType()->isIntegerTy()) {
1029 APInt Mask(APInt::getSignBit(I.getType()->getPrimitiveSizeInBits()));
1030 if (MaskedValueIsZero(Op1, Mask) && MaskedValueIsZero(Op0, Mask)) {
1031 // X srem Y -> X urem Y, iff X and Y don't have sign bit set
1032 return BinaryOperator::CreateURem(Op0, Op1, I.getName());
1036 // If it's a constant vector, flip any negative values positive.
1037 if (isa<ConstantVector>(Op1) || isa<ConstantDataVector>(Op1)) {
1038 Constant *C = cast<Constant>(Op1);
1039 unsigned VWidth = C->getType()->getVectorNumElements();
1041 bool hasNegative = false;
1042 bool hasMissing = false;
1043 for (unsigned i = 0; i != VWidth; ++i) {
1044 Constant *Elt = C->getAggregateElement(i);
1050 if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elt))
1051 if (RHS->isNegative())
1055 if (hasNegative && !hasMissing) {
1056 SmallVector<Constant *, 16> Elts(VWidth);
1057 for (unsigned i = 0; i != VWidth; ++i) {
1058 Elts[i] = C->getAggregateElement(i); // Handle undef, etc.
1059 if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elts[i])) {
1060 if (RHS->isNegative())
1061 Elts[i] = cast<ConstantInt>(ConstantExpr::getNeg(RHS));
1065 Constant *NewRHSV = ConstantVector::get(Elts);
1066 if (NewRHSV != C) { // Don't loop on -MININT
1067 Worklist.AddValue(I.getOperand(1));
1068 I.setOperand(1, NewRHSV);
1077 Instruction *InstCombiner::visitFRem(BinaryOperator &I) {
1078 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1080 if (Value *V = SimplifyFRemInst(Op0, Op1, TD))
1081 return ReplaceInstUsesWith(I, V);
1083 // Handle cases involving: rem X, (select Cond, Y, Z)
1084 if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))