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