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