lib/Transforms/InstCombine/InstCombineMulDivRem.cpp

   1 //===- InstCombineMulDivRem.cpp -------------------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the visit functions for mul, fmul, sdiv, udiv, fdiv,
  11 // srem, urem, frem.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "InstCombine.h"
  16 #include "llvm/Analysis/InstructionSimplify.h"
  17 #include "llvm/IR/IntrinsicInst.h"
  18 #include "llvm/Support/PatternMatch.h"
  19 using namespace llvm;
  20 using namespace PatternMatch;
  21
  22
  23 /// simplifyValueKnownNonZero - The specific integer value is used in a context
  24 /// where it is known to be non-zero.  If this allows us to simplify the
  25 /// computation, do so and return the new operand, otherwise return null.
  26 static Value *simplifyValueKnownNonZero(Value *V, InstCombiner &IC) {
  27   // If V has multiple uses, then we would have to do more analysis to determine
  28   // if this is safe.  For example, the use could be in dynamically unreached
  29   // code.
  30   if (!V->hasOneUse()) return 0;
  31
  32   bool MadeChange = false;
  33
  34   // ((1 << A) >>u B) --> (1 << (A-B))
  35   // Because V cannot be zero, we know that B is less than A.
  36   Value *A = 0, *B = 0, *PowerOf2 = 0;
  37   if (match(V, m_LShr(m_OneUse(m_Shl(m_Value(PowerOf2), m_Value(A))),
  38                       m_Value(B))) &&
  39       // The "1" can be any value known to be a power of 2.
  40       isKnownToBeAPowerOfTwo(PowerOf2)) {
  41     A = IC.Builder->CreateSub(A, B);
  42     return IC.Builder->CreateShl(PowerOf2, A);
  43   }
  44
  45   // (PowerOfTwo >>u B) --> isExact since shifting out the result would make it
  46   // inexact.  Similarly for <<.
  47   if (BinaryOperator *I = dyn_cast<BinaryOperator>(V))
  48     if (I->isLogicalShift() && isKnownToBeAPowerOfTwo(I->getOperand(0))) {
  49       // We know that this is an exact/nuw shift and that the input is a
  50       // non-zero context as well.
  51       if (Value *V2 = simplifyValueKnownNonZero(I->getOperand(0), IC)) {
  52         I->setOperand(0, V2);
  53         MadeChange = true;
  54       }
  55
  56       if (I->getOpcode() == Instruction::LShr && !I->isExact()) {
  57         I->setIsExact();
  58         MadeChange = true;
  59       }
  60
  61       if (I->getOpcode() == Instruction::Shl && !I->hasNoUnsignedWrap()) {
  62         I->setHasNoUnsignedWrap();
  63         MadeChange = true;
  64       }
  65     }
  66
  67   // TODO: Lots more we could do here:
  68   //    If V is a phi node, we can call this on each of its operands.
  69   //    "select cond, X, 0" can simplify to "X".
  70
  71   return MadeChange ? V : 0;
  72 }
  73
  74
  75 /// MultiplyOverflows - True if the multiply can not be expressed in an int
  76 /// this size.
  77 static bool MultiplyOverflows(ConstantInt *C1, ConstantInt *C2, bool sign) {
  78   uint32_t W = C1->getBitWidth();
  79   APInt LHSExt = C1->getValue(), RHSExt = C2->getValue();
  80   if (sign) {
  81     LHSExt = LHSExt.sext(W * 2);
  82     RHSExt = RHSExt.sext(W * 2);
  83   } else {
  84     LHSExt = LHSExt.zext(W * 2);
  85     RHSExt = RHSExt.zext(W * 2);
  86   }
  87
  88   APInt MulExt = LHSExt * RHSExt;
  89
  90   if (!sign)
  91     return MulExt.ugt(APInt::getLowBitsSet(W * 2, W));
  92
  93   APInt Min = APInt::getSignedMinValue(W).sext(W * 2);
  94   APInt Max = APInt::getSignedMaxValue(W).sext(W * 2);
  95   return MulExt.slt(Min) || MulExt.sgt(Max);
  96 }
  97
  98 Instruction *InstCombiner::visitMul(BinaryOperator &I) {
  99   bool Changed = SimplifyAssociativeOrCommutative(I);
 100   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 101
 102   if (Value *V = SimplifyMulInst(Op0, Op1, TD))
 103     return ReplaceInstUsesWith(I, V);
 104
 105   if (Value *V = SimplifyUsingDistributiveLaws(I))
 106     return ReplaceInstUsesWith(I, V);
 107
 108   if (match(Op1, m_AllOnes()))  // X * -1 == 0 - X
 109     return BinaryOperator::CreateNeg(Op0, I.getName());
 110
 111   if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
 112
 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));
 119
 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();
 126       return Shl;
 127     }
 128
 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));
 135       }
 136     }
 137
 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.
 141     {
 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()) {
 147           ConstantInt *C1;
 148           Value *Sub = 0;
 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");
 153           if (Sub)
 154             return
 155               BinaryOperator::CreateMul(Sub,
 156                                         ConstantInt::get(Y->getType(), PosVal));
 157         }
 158       }
 159     }
 160   }
 161
 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))
 167         return R;
 168
 169     if (isa<PHINode>(Op0))
 170       if (Instruction *NV = FoldOpIntoPhi(I))
 171         return NV;
 172   }
 173
 174   if (Value *Op0v = dyn_castNegVal(Op0))     // -X * -Y = X*Y
 175     if (Value *Op1v = dyn_castNegVal(Op1))
 176       return BinaryOperator::CreateMul(Op0v, Op1v);
 177
 178   // (X / Y) *  Y = X - (X % Y)
 179   // (X / Y) * -Y = (X % Y) - X
 180   {
 181     Value *Op1C = Op1;
 182     BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0);
 183     if (!BO ||
 184         (BO->getOpcode() != Instruction::UDiv &&
 185          BO->getOpcode() != Instruction::SDiv)) {
 186       Op1C = Op0;
 187       BO = dyn_cast<BinaryOperator>(Op1);
 188     }
 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);
 195
 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()) {
 199           if (Op1BO == Op1C)
 200             return ReplaceInstUsesWith(I, Op0BO);
 201           return BinaryOperator::CreateNeg(Op0BO);
 202         }
 203
 204       Value *Rem;
 205       if (BO->getOpcode() == Instruction::UDiv)
 206         Rem = Builder->CreateURem(Op0BO, Op1BO);
 207       else
 208         Rem = Builder->CreateSRem(Op0BO, Op1BO);
 209       Rem->takeName(BO);
 210
 211       if (Op1BO == Op1C)
 212         return BinaryOperator::CreateSub(Op0BO, Rem);
 213       return BinaryOperator::CreateSub(Rem, Op0BO);
 214     }
 215   }
 216
 217   /// i1 mul -> i1 and.
 218   if (I.getType()->isIntegerTy(1))
 219     return BinaryOperator::CreateAnd(Op0, Op1);
 220
 221   // X*(1 << Y) --> X << Y
 222   // (1 << Y)*X --> X << Y
 223   {
 224     Value *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);
 229   }
 230
 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);
 237
 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;
 243
 244     if (BoolCast) {
 245       Value *V = Builder->CreateSub(Constant::getNullValue(I.getType()),
 246                                     BoolCast);
 247       return BinaryOperator::CreateAnd(V, OtherOp);
 248     }
 249   }
 250
 251   return Changed ? &I : 0;
 252 }
 253
 254 //
 255 // Detect pattern:
 256 //
 257 // log2(Y*0.5)
 258 //
 259 // And check for corresponding fast math flags
 260 //
 261
 262 static void detectLog2OfHalf(Value *&Op, Value *&Y, IntrinsicInst *&Log2) {
 263
 264    if (!Op->hasOneUse())
 265      return;
 266
 267    IntrinsicInst *II = dyn_cast<IntrinsicInst>(Op);
 268    if (!II)
 269      return;
 270    if (II->getIntrinsicID() != Intrinsic::log2 || !II->hasUnsafeAlgebra())
 271      return;
 272    Log2 = II;
 273
 274    Value *OpLog2Of = II->getArgOperand(0);
 275    if (!OpLog2Of->hasOneUse())
 276      return;
 277
 278    Instruction *I = dyn_cast<Instruction>(OpLog2Of);
 279    if (!I)
 280      return;
 281    if (I->getOpcode() != Instruction::FMul || !I->hasUnsafeAlgebra())
 282      return;
 283
 284    ConstantFP *CFP = dyn_cast<ConstantFP>(I->getOperand(0));
 285    if (CFP && CFP->isExactlyValue(0.5)) {
 286      Y = I->getOperand(1);
 287      return;
 288    }
 289    CFP = dyn_cast<ConstantFP>(I->getOperand(1));
 290    if (CFP && CFP->isExactlyValue(0.5))
 291      Y = I->getOperand(0);
 292 }
 293
 294 Instruction *InstCombiner::visitFMul(BinaryOperator &I) {
 295   bool Changed = SimplifyAssociativeOrCommutative(I);
 296   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 297
 298   if (Value *V = SimplifyFMulInst(Op0, Op1, I.getFastMathFlags(), TD))
 299     return ReplaceInstUsesWith(I, V);
 300
 301   // Simplify mul instructions with a constant RHS.
 302   if (isa<Constant>(Op1)) {
 303     // Try to fold constant mul into select arguments.
 304     if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
 305       if (Instruction *R = FoldOpIntoSelect(I, SI))
 306         return R;
 307
 308     if (isa<PHINode>(Op0))
 309       if (Instruction *NV = FoldOpIntoPhi(I))
 310         return NV;
 311   }
 312
 313   if (Value *Op0v = dyn_castFNegVal(Op0))     // -X * -Y = X*Y
 314     if (Value *Op1v = dyn_castFNegVal(Op1))
 315       return BinaryOperator::CreateFMul(Op0v, Op1v);
 316
 317   // Under unsafe algebra do:
 318   // X * log2(0.5*Y) = X*log2(Y) - X
 319   if (I.hasUnsafeAlgebra()) {
 320     Value *OpX = NULL;
 321     Value *OpY = NULL;
 322     IntrinsicInst *Log2;
 323     detectLog2OfHalf(Op0, OpY, Log2);
 324     if (OpY) {
 325       OpX = Op1;
 326     } else {
 327       detectLog2OfHalf(Op1, OpY, Log2);
 328       if (OpY) {
 329         OpX = Op0;
 330       }
 331     }
 332     // if pattern detected emit alternate sequence
 333     if (OpX && OpY) {
 334       Log2->setArgOperand(0, OpY);
 335       Value *FMulVal = Builder->CreateFMul(OpX, Log2);
 336       Instruction *FMul = cast<Instruction>(FMulVal);
 337       FMul->copyFastMathFlags(Log2);
 338       Instruction *FSub = BinaryOperator::CreateFSub(FMulVal, OpX);
 339       FSub->copyFastMathFlags(Log2);
 340       return FSub;
 341     }
 342   }
 343
 344   // X * cond ? 1.0 : 0.0 => cond ? X : 0.0
 345   if (I.hasNoNaNs() && I.hasNoSignedZeros()) {
 346     Value *V0 = I.getOperand(0);
 347     Value *V1 = I.getOperand(1);
 348     Value *Cond, *SLHS, *SRHS;
 349     bool Match = false;
 350
 351     if (match(V0, m_Select(m_Value(Cond), m_Value(SLHS), m_Value(SRHS)))) {
 352       Match = true;
 353     } else if (match(V1, m_Select(m_Value(Cond), m_Value(SLHS),
 354                      m_Value(SRHS)))) {
 355       Match = true;
 356       std::swap(V0, V1);
 357     }
 358
 359     if (Match) {
 360       ConstantFP *C0 = dyn_cast<ConstantFP>(SLHS);
 361       ConstantFP *C1 = dyn_cast<ConstantFP>(SRHS);
 362
 363       if (C0 && C1 &&
 364           ((C0->isZero() && C1->isExactlyValue(1.0)) ||
 365            (C1->isZero() && C0->isExactlyValue(1.0)))) {
 366         Value *T;
 367         if (C0->isZero())
 368           T = Builder->CreateSelect(Cond, SLHS, V1);
 369         else
 370           T = Builder->CreateSelect(Cond, V1, SRHS);
 371         return ReplaceInstUsesWith(I, T);
 372       }
 373     }
 374   }
 375
 376   return Changed ? &I : 0;
 377 }
 378
 379 /// SimplifyDivRemOfSelect - Try to fold a divide or remainder of a select
 380 /// instruction.
 381 bool InstCombiner::SimplifyDivRemOfSelect(BinaryOperator &I) {
 382   SelectInst *SI = cast<SelectInst>(I.getOperand(1));
 383
 384   // div/rem X, (Cond ? 0 : Y) -> div/rem X, Y
 385   int NonNullOperand = -1;
 386   if (Constant *ST = dyn_cast<Constant>(SI->getOperand(1)))
 387     if (ST->isNullValue())
 388       NonNullOperand = 2;
 389   // div/rem X, (Cond ? Y : 0) -> div/rem X, Y
 390   if (Constant *ST = dyn_cast<Constant>(SI->getOperand(2)))
 391     if (ST->isNullValue())
 392       NonNullOperand = 1;
 393
 394   if (NonNullOperand == -1)
 395     return false;
 396
 397   Value *SelectCond = SI->getOperand(0);
 398
 399   // Change the div/rem to use 'Y' instead of the select.
 400   I.setOperand(1, SI->getOperand(NonNullOperand));
 401
 402   // Okay, we know we replace the operand of the div/rem with 'Y' with no
 403   // problem.  However, the select, or the condition of the select may have
 404   // multiple uses.  Based on our knowledge that the operand must be non-zero,
 405   // propagate the known value for the select into other uses of it, and
 406   // propagate a known value of the condition into its other users.
 407
 408   // If the select and condition only have a single use, don't bother with this,
 409   // early exit.
 410   if (SI->use_empty() && SelectCond->hasOneUse())
 411     return true;
 412
 413   // Scan the current block backward, looking for other uses of SI.
 414   BasicBlock::iterator BBI = &I, BBFront = I.getParent()->begin();
 415
 416   while (BBI != BBFront) {
 417     --BBI;
 418     // If we found a call to a function, we can't assume it will return, so
 419     // information from below it cannot be propagated above it.
 420     if (isa<CallInst>(BBI) && !isa<IntrinsicInst>(BBI))
 421       break;
 422
 423     // Replace uses of the select or its condition with the known values.
 424     for (Instruction::op_iterator I = BBI->op_begin(), E = BBI->op_end();
 425          I != E; ++I) {
 426       if (*I == SI) {
 427         *I = SI->getOperand(NonNullOperand);
 428         Worklist.Add(BBI);
 429       } else if (*I == SelectCond) {
 430         *I = NonNullOperand == 1 ? ConstantInt::getTrue(BBI->getContext()) :
 431                                    ConstantInt::getFalse(BBI->getContext());
 432         Worklist.Add(BBI);
 433       }
 434     }
 435
 436     // If we past the instruction, quit looking for it.
 437     if (&*BBI == SI)
 438       SI = 0;
 439     if (&*BBI == SelectCond)
 440       SelectCond = 0;
 441
 442     // If we ran out of things to eliminate, break out of the loop.
 443     if (SelectCond == 0 && SI == 0)
 444       break;
 445
 446   }
 447   return true;
 448 }
 449
 450
 451 /// This function implements the transforms common to both integer division
 452 /// instructions (udiv and sdiv). It is called by the visitors to those integer
 453 /// division instructions.
 454 /// @brief Common integer divide transforms
 455 Instruction *InstCombiner::commonIDivTransforms(BinaryOperator &I) {
 456   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 457
 458   // The RHS is known non-zero.
 459   if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this)) {
 460     I.setOperand(1, V);
 461     return &I;
 462   }
 463
 464   // Handle cases involving: [su]div X, (select Cond, Y, Z)
 465   // This does not apply for fdiv.
 466   if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
 467     return &I;
 468
 469   if (ConstantInt *RHS = dyn_cast<ConstantInt>(Op1)) {
 470     // (X / C1) / C2  -> X / (C1*C2)
 471     if (Instruction *LHS = dyn_cast<Instruction>(Op0))
 472       if (Instruction::BinaryOps(LHS->getOpcode()) == I.getOpcode())
 473         if (ConstantInt *LHSRHS = dyn_cast<ConstantInt>(LHS->getOperand(1))) {
 474           if (MultiplyOverflows(RHS, LHSRHS,
 475                                 I.getOpcode()==Instruction::SDiv))
 476             return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 477           return BinaryOperator::Create(I.getOpcode(), LHS->getOperand(0),
 478                                         ConstantExpr::getMul(RHS, LHSRHS));
 479         }
 480
 481     if (!RHS->isZero()) { // avoid X udiv 0
 482       if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
 483         if (Instruction *R = FoldOpIntoSelect(I, SI))
 484           return R;
 485       if (isa<PHINode>(Op0))
 486         if (Instruction *NV = FoldOpIntoPhi(I))
 487           return NV;
 488     }
 489   }
 490
 491   // See if we can fold away this div instruction.
 492   if (SimplifyDemandedInstructionBits(I))
 493     return &I;
 494
 495   // (X - (X rem Y)) / Y -> X / Y; usually originates as ((X / Y) * Y) / Y
 496   Value *X = 0, *Z = 0;
 497   if (match(Op0, m_Sub(m_Value(X), m_Value(Z)))) { // (X - Z) / Y; Y = Op1
 498     bool isSigned = I.getOpcode() == Instruction::SDiv;
 499     if ((isSigned && match(Z, m_SRem(m_Specific(X), m_Specific(Op1)))) ||
 500         (!isSigned && match(Z, m_URem(m_Specific(X), m_Specific(Op1)))))
 501       return BinaryOperator::Create(I.getOpcode(), X, Op1);
 502   }
 503
 504   return 0;
 505 }
 506
 507 /// dyn_castZExtVal - Checks if V is a zext or constant that can
 508 /// be truncated to Ty without losing bits.
 509 static Value *dyn_castZExtVal(Value *V, Type *Ty) {
 510   if (ZExtInst *Z = dyn_cast<ZExtInst>(V)) {
 511     if (Z->getSrcTy() == Ty)
 512       return Z->getOperand(0);
 513   } else if (ConstantInt *C = dyn_cast<ConstantInt>(V)) {
 514     if (C->getValue().getActiveBits() <= cast<IntegerType>(Ty)->getBitWidth())
 515       return ConstantExpr::getTrunc(C, Ty);
 516   }
 517   return 0;
 518 }
 519
 520 Instruction *InstCombiner::visitUDiv(BinaryOperator &I) {
 521   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 522
 523   if (Value *V = SimplifyUDivInst(Op0, Op1, TD))
 524     return ReplaceInstUsesWith(I, V);
 525
 526   // Handle the integer div common cases
 527   if (Instruction *Common = commonIDivTransforms(I))
 528     return Common;
 529
 530   {
 531     // X udiv 2^C -> X >> C
 532     // Check to see if this is an unsigned division with an exact power of 2,
 533     // if so, convert to a right shift.
 534     const APInt *C;
 535     if (match(Op1, m_Power2(C))) {
 536       BinaryOperator *LShr =
 537       BinaryOperator::CreateLShr(Op0,
 538                                  ConstantInt::get(Op0->getType(),
 539                                                   C->logBase2()));
 540       if (I.isExact()) LShr->setIsExact();
 541       return LShr;
 542     }
 543   }
 544
 545   if (ConstantInt *C = dyn_cast<ConstantInt>(Op1)) {
 546     // X udiv C, where C >= signbit
 547     if (C->getValue().isNegative()) {
 548       Value *IC = Builder->CreateICmpULT(Op0, C);
 549       return SelectInst::Create(IC, Constant::getNullValue(I.getType()),
 550                                 ConstantInt::get(I.getType(), 1));
 551     }
 552   }
 553
 554   // (x lshr C1) udiv C2 --> x udiv (C2 << C1)
 555   if (ConstantInt *C2 = dyn_cast<ConstantInt>(Op1)) {
 556     Value *X;
 557     ConstantInt *C1;
 558     if (match(Op0, m_LShr(m_Value(X), m_ConstantInt(C1)))) {
 559       APInt NC = C2->getValue().shl(C1->getLimitedValue(C1->getBitWidth()-1));
 560       return BinaryOperator::CreateUDiv(X, Builder->getInt(NC));
 561     }
 562   }
 563
 564   // X udiv (C1 << N), where C1 is "1<<C2"  -->  X >> (N+C2)
 565   { const APInt *CI; Value *N;
 566     if (match(Op1, m_Shl(m_Power2(CI), m_Value(N))) ||
 567         match(Op1, m_ZExt(m_Shl(m_Power2(CI), m_Value(N))))) {
 568       if (*CI != 1)
 569         N = Builder->CreateAdd(N,
 570                                ConstantInt::get(N->getType(), CI->logBase2()));
 571       if (ZExtInst *Z = dyn_cast<ZExtInst>(Op1))
 572         N = Builder->CreateZExt(N, Z->getDestTy());
 573       if (I.isExact())
 574         return BinaryOperator::CreateExactLShr(Op0, N);
 575       return BinaryOperator::CreateLShr(Op0, N);
 576     }
 577   }
 578
 579   // udiv X, (Select Cond, C1, C2) --> Select Cond, (shr X, C1), (shr X, C2)
 580   // where C1&C2 are powers of two.
 581   { Value *Cond; const APInt *C1, *C2;
 582     if (match(Op1, m_Select(m_Value(Cond), m_Power2(C1), m_Power2(C2)))) {
 583       // Construct the "on true" case of the select
 584       Value *TSI = Builder->CreateLShr(Op0, C1->logBase2(), Op1->getName()+".t",
 585                                        I.isExact());
 586
 587       // Construct the "on false" case of the select
 588       Value *FSI = Builder->CreateLShr(Op0, C2->logBase2(), Op1->getName()+".f",
 589                                        I.isExact());
 590
 591       // construct the select instruction and return it.
 592       return SelectInst::Create(Cond, TSI, FSI);
 593     }
 594   }
 595
 596   // (zext A) udiv (zext B) --> zext (A udiv B)
 597   if (ZExtInst *ZOp0 = dyn_cast<ZExtInst>(Op0))
 598     if (Value *ZOp1 = dyn_castZExtVal(Op1, ZOp0->getSrcTy()))
 599       return new ZExtInst(Builder->CreateUDiv(ZOp0->getOperand(0), ZOp1, "div",
 600                                               I.isExact()),
 601                           I.getType());
 602
 603   return 0;
 604 }
 605
 606 Instruction *InstCombiner::visitSDiv(BinaryOperator &I) {
 607   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 608
 609   if (Value *V = SimplifySDivInst(Op0, Op1, TD))
 610     return ReplaceInstUsesWith(I, V);
 611
 612   // Handle the integer div common cases
 613   if (Instruction *Common = commonIDivTransforms(I))
 614     return Common;
 615
 616   if (ConstantInt *RHS = dyn_cast<ConstantInt>(Op1)) {
 617     // sdiv X, -1 == -X
 618     if (RHS->isAllOnesValue())
 619       return BinaryOperator::CreateNeg(Op0);
 620
 621     // sdiv X, C  -->  ashr exact X, log2(C)
 622     if (I.isExact() && RHS->getValue().isNonNegative() &&
 623         RHS->getValue().isPowerOf2()) {
 624       Value *ShAmt = llvm::ConstantInt::get(RHS->getType(),
 625                                             RHS->getValue().exactLogBase2());
 626       return BinaryOperator::CreateExactAShr(Op0, ShAmt, I.getName());
 627     }
 628
 629     // -X/C  -->  X/-C  provided the negation doesn't overflow.
 630     if (SubOperator *Sub = dyn_cast<SubOperator>(Op0))
 631       if (match(Sub->getOperand(0), m_Zero()) && Sub->hasNoSignedWrap())
 632         return BinaryOperator::CreateSDiv(Sub->getOperand(1),
 633                                           ConstantExpr::getNeg(RHS));
 634   }
 635
 636   // If the sign bits of both operands are zero (i.e. we can prove they are
 637   // unsigned inputs), turn this into a udiv.
 638   if (I.getType()->isIntegerTy()) {
 639     APInt Mask(APInt::getSignBit(I.getType()->getPrimitiveSizeInBits()));
 640     if (MaskedValueIsZero(Op0, Mask)) {
 641       if (MaskedValueIsZero(Op1, Mask)) {
 642         // X sdiv Y -> X udiv Y, iff X and Y don't have sign bit set
 643         return BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
 644       }
 645
 646       if (match(Op1, m_Shl(m_Power2(), m_Value()))) {
 647         // X sdiv (1 << Y) -> X udiv (1 << Y) ( -> X u>> Y)
 648         // Safe because the only negative value (1 << Y) can take on is
 649         // INT_MIN, and X sdiv INT_MIN == X udiv INT_MIN == 0 if X doesn't have
 650         // the sign bit set.
 651         return BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
 652       }
 653     }
 654   }
 655
 656   return 0;
 657 }
 658
 659 Instruction *InstCombiner::visitFDiv(BinaryOperator &I) {
 660   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 661
 662   if (Value *V = SimplifyFDivInst(Op0, Op1, TD))
 663     return ReplaceInstUsesWith(I, V);
 664
 665   if (ConstantFP *Op1C = dyn_cast<ConstantFP>(Op1)) {
 666     const APFloat &Op1F = Op1C->getValueAPF();
 667
 668     // If the divisor has an exact multiplicative inverse we can turn the fdiv
 669     // into a cheaper fmul.
 670     APFloat Reciprocal(Op1F.getSemantics());
 671     if (Op1F.getExactInverse(&Reciprocal)) {
 672       ConstantFP *RFP = ConstantFP::get(Builder->getContext(), Reciprocal);
 673       return BinaryOperator::CreateFMul(Op0, RFP);
 674     }
 675   }
 676
 677   return 0;
 678 }
 679
 680 /// This function implements the transforms common to both integer remainder
 681 /// instructions (urem and srem). It is called by the visitors to those integer
 682 /// remainder instructions.
 683 /// @brief Common integer remainder transforms
 684 Instruction *InstCombiner::commonIRemTransforms(BinaryOperator &I) {
 685   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 686
 687   // The RHS is known non-zero.
 688   if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this)) {
 689     I.setOperand(1, V);
 690     return &I;
 691   }
 692
 693   // Handle cases involving: rem X, (select Cond, Y, Z)
 694   if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
 695     return &I;
 696
 697   if (isa<ConstantInt>(Op1)) {
 698     if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
 699       if (SelectInst *SI = dyn_cast<SelectInst>(Op0I)) {
 700         if (Instruction *R = FoldOpIntoSelect(I, SI))
 701           return R;
 702       } else if (isa<PHINode>(Op0I)) {
 703         if (Instruction *NV = FoldOpIntoPhi(I))
 704           return NV;
 705       }
 706
 707       // See if we can fold away this rem instruction.
 708       if (SimplifyDemandedInstructionBits(I))
 709         return &I;
 710     }
 711   }
 712
 713   return 0;
 714 }
 715
 716 Instruction *InstCombiner::visitURem(BinaryOperator &I) {
 717   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 718
 719   if (Value *V = SimplifyURemInst(Op0, Op1, TD))
 720     return ReplaceInstUsesWith(I, V);
 721
 722   if (Instruction *common = commonIRemTransforms(I))
 723     return common;
 724
 725   // X urem C^2 -> X and C-1
 726   { const APInt *C;
 727     if (match(Op1, m_Power2(C)))
 728       return BinaryOperator::CreateAnd(Op0,
 729                                        ConstantInt::get(I.getType(), *C-1));
 730   }
 731
 732   // Turn A % (C << N), where C is 2^k, into A & ((C << N)-1)
 733   if (match(Op1, m_Shl(m_Power2(), m_Value()))) {
 734     Constant *N1 = Constant::getAllOnesValue(I.getType());
 735     Value *Add = Builder->CreateAdd(Op1, N1);
 736     return BinaryOperator::CreateAnd(Op0, Add);
 737   }
 738
 739   // urem X, (select Cond, 2^C1, 2^C2) -->
 740   //    select Cond, (and X, C1-1), (and X, C2-1)
 741   // when C1&C2 are powers of two.
 742   { Value *Cond; const APInt *C1, *C2;
 743     if (match(Op1, m_Select(m_Value(Cond), m_Power2(C1), m_Power2(C2)))) {
 744       Value *TrueAnd = Builder->CreateAnd(Op0, *C1-1, Op1->getName()+".t");
 745       Value *FalseAnd = Builder->CreateAnd(Op0, *C2-1, Op1->getName()+".f");
 746       return SelectInst::Create(Cond, TrueAnd, FalseAnd);
 747     }
 748   }
 749
 750   // (zext A) urem (zext B) --> zext (A urem B)
 751   if (ZExtInst *ZOp0 = dyn_cast<ZExtInst>(Op0))
 752     if (Value *ZOp1 = dyn_castZExtVal(Op1, ZOp0->getSrcTy()))
 753       return new ZExtInst(Builder->CreateURem(ZOp0->getOperand(0), ZOp1),
 754                           I.getType());
 755
 756   return 0;
 757 }
 758
 759 Instruction *InstCombiner::visitSRem(BinaryOperator &I) {
 760   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 761
 762   if (Value *V = SimplifySRemInst(Op0, Op1, TD))
 763     return ReplaceInstUsesWith(I, V);
 764
 765   // Handle the integer rem common cases
 766   if (Instruction *Common = commonIRemTransforms(I))
 767     return Common;
 768
 769   if (Value *RHSNeg = dyn_castNegVal(Op1))
 770     if (!isa<Constant>(RHSNeg) ||
 771         (isa<ConstantInt>(RHSNeg) &&
 772          cast<ConstantInt>(RHSNeg)->getValue().isStrictlyPositive())) {
 773       // X % -Y -> X % Y
 774       Worklist.AddValue(I.getOperand(1));
 775       I.setOperand(1, RHSNeg);
 776       return &I;
 777     }
 778
 779   // If the sign bits of both operands are zero (i.e. we can prove they are
 780   // unsigned inputs), turn this into a urem.
 781   if (I.getType()->isIntegerTy()) {
 782     APInt Mask(APInt::getSignBit(I.getType()->getPrimitiveSizeInBits()));
 783     if (MaskedValueIsZero(Op1, Mask) && MaskedValueIsZero(Op0, Mask)) {
 784       // X srem Y -> X urem Y, iff X and Y don't have sign bit set
 785       return BinaryOperator::CreateURem(Op0, Op1, I.getName());
 786     }
 787   }
 788
 789   // If it's a constant vector, flip any negative values positive.
 790   if (isa<ConstantVector>(Op1) || isa<ConstantDataVector>(Op1)) {
 791     Constant *C = cast<Constant>(Op1);
 792     unsigned VWidth = C->getType()->getVectorNumElements();
 793
 794     bool hasNegative = false;
 795     bool hasMissing = false;
 796     for (unsigned i = 0; i != VWidth; ++i) {
 797       Constant *Elt = C->getAggregateElement(i);
 798       if (Elt == 0) {
 799         hasMissing = true;
 800         break;
 801       }
 802
 803       if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elt))
 804         if (RHS->isNegative())
 805           hasNegative = true;
 806     }
 807
 808     if (hasNegative && !hasMissing) {
 809       SmallVector<Constant *, 16> Elts(VWidth);
 810       for (unsigned i = 0; i != VWidth; ++i) {
 811         Elts[i] = C->getAggregateElement(i);  // Handle undef, etc.
 812         if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elts[i])) {
 813           if (RHS->isNegative())
 814             Elts[i] = cast<ConstantInt>(ConstantExpr::getNeg(RHS));
 815         }
 816       }
 817
 818       Constant *NewRHSV = ConstantVector::get(Elts);
 819       if (NewRHSV != C) {  // Don't loop on -MININT
 820         Worklist.AddValue(I.getOperand(1));
 821         I.setOperand(1, NewRHSV);
 822         return &I;
 823       }
 824     }
 825   }
 826
 827   return 0;
 828 }
 829
 830 Instruction *InstCombiner::visitFRem(BinaryOperator &I) {
 831   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 832
 833   if (Value *V = SimplifyFRemInst(Op0, Op1, TD))
 834     return ReplaceInstUsesWith(I, V);
 835
 836   // Handle cases involving: rem X, (select Cond, Y, Z)
 837   if (isa<SelectInst>(Op1) && SimplifyDivRemOfSelect(I))
 838     return &I;
 839
 840   return 0;
 841 }