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/InstCombiner.h" 35 #include "llvm/Transforms/Utils/BuildLibCalls.h" 36 #include <cassert> 37 #include <cstddef> 38 #include <cstdint> 39 #include <utility> 40 41 #define DEBUG_TYPE "instcombine" 42 #include "llvm/Transforms/Utils/InstructionWorklist.h" 43 44 using namespace llvm; 45 using namespace PatternMatch; 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() || X == Y)) { 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 if (I.isOnlyUserOfAnyOperand()) { 559 // pow(x, y) * pow(x, z) -> pow(x, y + z) 560 if (match(Op0, m_Intrinsic<Intrinsic::pow>(m_Value(X), m_Value(Y))) && 561 match(Op1, m_Intrinsic<Intrinsic::pow>(m_Specific(X), m_Value(Z)))) { 562 auto *YZ = Builder.CreateFAddFMF(Y, Z, &I); 563 auto *NewPow = Builder.CreateBinaryIntrinsic(Intrinsic::pow, X, YZ, &I); 564 return replaceInstUsesWith(I, NewPow); 565 } 566 567 // powi(x, y) * powi(x, z) -> powi(x, y + z) 568 if (match(Op0, m_Intrinsic<Intrinsic::powi>(m_Value(X), m_Value(Y))) && 569 match(Op1, m_Intrinsic<Intrinsic::powi>(m_Specific(X), m_Value(Z))) && 570 Y->getType() == Z->getType()) { 571 auto *YZ = Builder.CreateAdd(Y, Z); 572 auto *NewPow = Builder.CreateIntrinsic( 573 Intrinsic::powi, {X->getType(), YZ->getType()}, {X, YZ}, &I); 574 return replaceInstUsesWith(I, NewPow); 575 } 576 577 // exp(X) * exp(Y) -> exp(X + Y) 578 if (match(Op0, m_Intrinsic<Intrinsic::exp>(m_Value(X))) && 579 match(Op1, m_Intrinsic<Intrinsic::exp>(m_Value(Y)))) { 580 Value *XY = Builder.CreateFAddFMF(X, Y, &I); 581 Value *Exp = Builder.CreateUnaryIntrinsic(Intrinsic::exp, XY, &I); 582 return replaceInstUsesWith(I, Exp); 583 } 584 585 // exp2(X) * exp2(Y) -> exp2(X + Y) 586 if (match(Op0, m_Intrinsic<Intrinsic::exp2>(m_Value(X))) && 587 match(Op1, m_Intrinsic<Intrinsic::exp2>(m_Value(Y)))) { 588 Value *XY = Builder.CreateFAddFMF(X, Y, &I); 589 Value *Exp2 = Builder.CreateUnaryIntrinsic(Intrinsic::exp2, XY, &I); 590 return replaceInstUsesWith(I, Exp2); 591 } 592 } 593 594 // (X*Y) * X => (X*X) * Y where Y != X 595 // The purpose is two-fold: 596 // 1) to form a power expression (of X). 597 // 2) potentially shorten the critical path: After transformation, the 598 // latency of the instruction Y is amortized by the expression of X*X, 599 // and therefore Y is in a "less critical" position compared to what it 600 // was before the transformation. 601 if (match(Op0, m_OneUse(m_c_FMul(m_Specific(Op1), m_Value(Y)))) && 602 Op1 != Y) { 603 Value *XX = Builder.CreateFMulFMF(Op1, Op1, &I); 604 return BinaryOperator::CreateFMulFMF(XX, Y, &I); 605 } 606 if (match(Op1, m_OneUse(m_c_FMul(m_Specific(Op0), m_Value(Y)))) && 607 Op0 != Y) { 608 Value *XX = Builder.CreateFMulFMF(Op0, Op0, &I); 609 return BinaryOperator::CreateFMulFMF(XX, Y, &I); 610 } 611 } 612 613 // log2(X * 0.5) * Y = log2(X) * Y - Y 614 if (I.isFast()) { 615 IntrinsicInst *Log2 = nullptr; 616 if (match(Op0, m_OneUse(m_Intrinsic<Intrinsic::log2>( 617 m_OneUse(m_FMul(m_Value(X), m_SpecificFP(0.5))))))) { 618 Log2 = cast<IntrinsicInst>(Op0); 619 Y = Op1; 620 } 621 if (match(Op1, m_OneUse(m_Intrinsic<Intrinsic::log2>( 622 m_OneUse(m_FMul(m_Value(X), m_SpecificFP(0.5))))))) { 623 Log2 = cast<IntrinsicInst>(Op1); 624 Y = Op0; 625 } 626 if (Log2) { 627 Value *Log2 = Builder.CreateUnaryIntrinsic(Intrinsic::log2, X, &I); 628 Value *LogXTimesY = Builder.CreateFMulFMF(Log2, Y, &I); 629 return BinaryOperator::CreateFSubFMF(LogXTimesY, Y, &I); 630 } 631 } 632 633 return nullptr; 634 } 635 636 /// Fold a divide or remainder with a select instruction divisor when one of the 637 /// select operands is zero. In that case, we can use the other select operand 638 /// because div/rem by zero is undefined. 639 bool InstCombinerImpl::simplifyDivRemOfSelectWithZeroOp(BinaryOperator &I) { 640 SelectInst *SI = dyn_cast<SelectInst>(I.getOperand(1)); 641 if (!SI) 642 return false; 643 644 int NonNullOperand; 645 if (match(SI->getTrueValue(), m_Zero())) 646 // div/rem X, (Cond ? 0 : Y) -> div/rem X, Y 647 NonNullOperand = 2; 648 else if (match(SI->getFalseValue(), m_Zero())) 649 // div/rem X, (Cond ? Y : 0) -> div/rem X, Y 650 NonNullOperand = 1; 651 else 652 return false; 653 654 // Change the div/rem to use 'Y' instead of the select. 655 replaceOperand(I, 1, SI->getOperand(NonNullOperand)); 656 657 // Okay, we know we replace the operand of the div/rem with 'Y' with no 658 // problem. However, the select, or the condition of the select may have 659 // multiple uses. Based on our knowledge that the operand must be non-zero, 660 // propagate the known value for the select into other uses of it, and 661 // propagate a known value of the condition into its other users. 662 663 // If the select and condition only have a single use, don't bother with this, 664 // early exit. 665 Value *SelectCond = SI->getCondition(); 666 if (SI->use_empty() && SelectCond->hasOneUse()) 667 return true; 668 669 // Scan the current block backward, looking for other uses of SI. 670 BasicBlock::iterator BBI = I.getIterator(), BBFront = I.getParent()->begin(); 671 Type *CondTy = SelectCond->getType(); 672 while (BBI != BBFront) { 673 --BBI; 674 // If we found an instruction that we can't assume will return, so 675 // information from below it cannot be propagated above it. 676 if (!isGuaranteedToTransferExecutionToSuccessor(&*BBI)) 677 break; 678 679 // Replace uses of the select or its condition with the known values. 680 for (Use &Op : BBI->operands()) { 681 if (Op == SI) { 682 replaceUse(Op, SI->getOperand(NonNullOperand)); 683 Worklist.push(&*BBI); 684 } else if (Op == SelectCond) { 685 replaceUse(Op, NonNullOperand == 1 ? ConstantInt::getTrue(CondTy) 686 : ConstantInt::getFalse(CondTy)); 687 Worklist.push(&*BBI); 688 } 689 } 690 691 // If we past the instruction, quit looking for it. 692 if (&*BBI == SI) 693 SI = nullptr; 694 if (&*BBI == SelectCond) 695 SelectCond = nullptr; 696 697 // If we ran out of things to eliminate, break out of the loop. 698 if (!SelectCond && !SI) 699 break; 700 701 } 702 return true; 703 } 704 705 /// True if the multiply can not be expressed in an int this size. 706 static bool multiplyOverflows(const APInt &C1, const APInt &C2, APInt &Product, 707 bool IsSigned) { 708 bool Overflow; 709 Product = IsSigned ? C1.smul_ov(C2, Overflow) : C1.umul_ov(C2, Overflow); 710 return Overflow; 711 } 712 713 /// True if C1 is a multiple of C2. Quotient contains C1/C2. 714 static bool isMultiple(const APInt &C1, const APInt &C2, APInt &Quotient, 715 bool IsSigned) { 716 assert(C1.getBitWidth() == C2.getBitWidth() && "Constant widths not equal"); 717 718 // Bail if we will divide by zero. 719 if (C2.isNullValue()) 720 return false; 721 722 // Bail if we would divide INT_MIN by -1. 723 if (IsSigned && C1.isMinSignedValue() && C2.isAllOnesValue()) 724 return false; 725 726 APInt Remainder(C1.getBitWidth(), /*val=*/0ULL, IsSigned); 727 if (IsSigned) 728 APInt::sdivrem(C1, C2, Quotient, Remainder); 729 else 730 APInt::udivrem(C1, C2, Quotient, Remainder); 731 732 return Remainder.isMinValue(); 733 } 734 735 /// This function implements the transforms common to both integer division 736 /// instructions (udiv and sdiv). It is called by the visitors to those integer 737 /// division instructions. 738 /// Common integer divide transforms 739 Instruction *InstCombinerImpl::commonIDivTransforms(BinaryOperator &I) { 740 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 741 bool IsSigned = I.getOpcode() == Instruction::SDiv; 742 Type *Ty = I.getType(); 743 744 // The RHS is known non-zero. 745 if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I)) 746 return replaceOperand(I, 1, V); 747 748 // Handle cases involving: [su]div X, (select Cond, Y, Z) 749 // This does not apply for fdiv. 750 if (simplifyDivRemOfSelectWithZeroOp(I)) 751 return &I; 752 753 const APInt *C2; 754 if (match(Op1, m_APInt(C2))) { 755 Value *X; 756 const APInt *C1; 757 758 // (X / C1) / C2 -> X / (C1*C2) 759 if ((IsSigned && match(Op0, m_SDiv(m_Value(X), m_APInt(C1)))) || 760 (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_APInt(C1))))) { 761 APInt Product(C1->getBitWidth(), /*val=*/0ULL, IsSigned); 762 if (!multiplyOverflows(*C1, *C2, Product, IsSigned)) 763 return BinaryOperator::Create(I.getOpcode(), X, 764 ConstantInt::get(Ty, Product)); 765 } 766 767 if ((IsSigned && match(Op0, m_NSWMul(m_Value(X), m_APInt(C1)))) || 768 (!IsSigned && match(Op0, m_NUWMul(m_Value(X), m_APInt(C1))))) { 769 APInt Quotient(C1->getBitWidth(), /*val=*/0ULL, IsSigned); 770 771 // (X * C1) / C2 -> X / (C2 / C1) if C2 is a multiple of C1. 772 if (isMultiple(*C2, *C1, Quotient, IsSigned)) { 773 auto *NewDiv = BinaryOperator::Create(I.getOpcode(), X, 774 ConstantInt::get(Ty, Quotient)); 775 NewDiv->setIsExact(I.isExact()); 776 return NewDiv; 777 } 778 779 // (X * C1) / C2 -> X * (C1 / C2) if C1 is a multiple of C2. 780 if (isMultiple(*C1, *C2, Quotient, IsSigned)) { 781 auto *Mul = BinaryOperator::Create(Instruction::Mul, X, 782 ConstantInt::get(Ty, Quotient)); 783 auto *OBO = cast<OverflowingBinaryOperator>(Op0); 784 Mul->setHasNoUnsignedWrap(!IsSigned && OBO->hasNoUnsignedWrap()); 785 Mul->setHasNoSignedWrap(OBO->hasNoSignedWrap()); 786 return Mul; 787 } 788 } 789 790 if ((IsSigned && match(Op0, m_NSWShl(m_Value(X), m_APInt(C1))) && 791 C1->ult(C1->getBitWidth() - 1)) || 792 (!IsSigned && match(Op0, m_NUWShl(m_Value(X), m_APInt(C1))) && 793 C1->ult(C1->getBitWidth()))) { 794 APInt Quotient(C1->getBitWidth(), /*val=*/0ULL, IsSigned); 795 APInt C1Shifted = APInt::getOneBitSet( 796 C1->getBitWidth(), static_cast<unsigned>(C1->getZExtValue())); 797 798 // (X << C1) / C2 -> X / (C2 >> C1) if C2 is a multiple of 1 << C1. 799 if (isMultiple(*C2, C1Shifted, Quotient, IsSigned)) { 800 auto *BO = BinaryOperator::Create(I.getOpcode(), X, 801 ConstantInt::get(Ty, Quotient)); 802 BO->setIsExact(I.isExact()); 803 return BO; 804 } 805 806 // (X << C1) / C2 -> X * ((1 << C1) / C2) if 1 << C1 is a multiple of C2. 807 if (isMultiple(C1Shifted, *C2, Quotient, IsSigned)) { 808 auto *Mul = BinaryOperator::Create(Instruction::Mul, X, 809 ConstantInt::get(Ty, Quotient)); 810 auto *OBO = cast<OverflowingBinaryOperator>(Op0); 811 Mul->setHasNoUnsignedWrap(!IsSigned && OBO->hasNoUnsignedWrap()); 812 Mul->setHasNoSignedWrap(OBO->hasNoSignedWrap()); 813 return Mul; 814 } 815 } 816 817 if (!C2->isNullValue()) // avoid X udiv 0 818 if (Instruction *FoldedDiv = foldBinOpIntoSelectOrPhi(I)) 819 return FoldedDiv; 820 } 821 822 if (match(Op0, m_One())) { 823 assert(!Ty->isIntOrIntVectorTy(1) && "i1 divide not removed?"); 824 if (IsSigned) { 825 // If Op1 is 0 then it's undefined behaviour, if Op1 is 1 then the 826 // result is one, if Op1 is -1 then the result is minus one, otherwise 827 // it's zero. 828 Value *Inc = Builder.CreateAdd(Op1, Op0); 829 Value *Cmp = Builder.CreateICmpULT(Inc, ConstantInt::get(Ty, 3)); 830 return SelectInst::Create(Cmp, Op1, ConstantInt::get(Ty, 0)); 831 } else { 832 // If Op1 is 0 then it's undefined behaviour. If Op1 is 1 then the 833 // result is one, otherwise it's zero. 834 return new ZExtInst(Builder.CreateICmpEQ(Op1, Op0), Ty); 835 } 836 } 837 838 // See if we can fold away this div instruction. 839 if (SimplifyDemandedInstructionBits(I)) 840 return &I; 841 842 // (X - (X rem Y)) / Y -> X / Y; usually originates as ((X / Y) * Y) / Y 843 Value *X, *Z; 844 if (match(Op0, m_Sub(m_Value(X), m_Value(Z)))) // (X - Z) / Y; Y = Op1 845 if ((IsSigned && match(Z, m_SRem(m_Specific(X), m_Specific(Op1)))) || 846 (!IsSigned && match(Z, m_URem(m_Specific(X), m_Specific(Op1))))) 847 return BinaryOperator::Create(I.getOpcode(), X, Op1); 848 849 // (X << Y) / X -> 1 << Y 850 Value *Y; 851 if (IsSigned && match(Op0, m_NSWShl(m_Specific(Op1), m_Value(Y)))) 852 return BinaryOperator::CreateNSWShl(ConstantInt::get(Ty, 1), Y); 853 if (!IsSigned && match(Op0, m_NUWShl(m_Specific(Op1), m_Value(Y)))) 854 return BinaryOperator::CreateNUWShl(ConstantInt::get(Ty, 1), Y); 855 856 // X / (X * Y) -> 1 / Y if the multiplication does not overflow. 857 if (match(Op1, m_c_Mul(m_Specific(Op0), m_Value(Y)))) { 858 bool HasNSW = cast<OverflowingBinaryOperator>(Op1)->hasNoSignedWrap(); 859 bool HasNUW = cast<OverflowingBinaryOperator>(Op1)->hasNoUnsignedWrap(); 860 if ((IsSigned && HasNSW) || (!IsSigned && HasNUW)) { 861 replaceOperand(I, 0, ConstantInt::get(Ty, 1)); 862 replaceOperand(I, 1, Y); 863 return &I; 864 } 865 } 866 867 return nullptr; 868 } 869 870 static const unsigned MaxDepth = 6; 871 872 namespace { 873 874 using FoldUDivOperandCb = Instruction *(*)(Value *Op0, Value *Op1, 875 const BinaryOperator &I, 876 InstCombinerImpl &IC); 877 878 /// Used to maintain state for visitUDivOperand(). 879 struct UDivFoldAction { 880 /// Informs visitUDiv() how to fold this operand. This can be zero if this 881 /// action joins two actions together. 882 FoldUDivOperandCb FoldAction; 883 884 /// Which operand to fold. 885 Value *OperandToFold; 886 887 union { 888 /// The instruction returned when FoldAction is invoked. 889 Instruction *FoldResult; 890 891 /// Stores the LHS action index if this action joins two actions together. 892 size_t SelectLHSIdx; 893 }; 894 895 UDivFoldAction(FoldUDivOperandCb FA, Value *InputOperand) 896 : FoldAction(FA), OperandToFold(InputOperand), FoldResult(nullptr) {} 897 UDivFoldAction(FoldUDivOperandCb FA, Value *InputOperand, size_t SLHS) 898 : FoldAction(FA), OperandToFold(InputOperand), SelectLHSIdx(SLHS) {} 899 }; 900 901 } // end anonymous namespace 902 903 // X udiv 2^C -> X >> C 904 static Instruction *foldUDivPow2Cst(Value *Op0, Value *Op1, 905 const BinaryOperator &I, 906 InstCombinerImpl &IC) { 907 Constant *C1 = ConstantExpr::getExactLogBase2(cast<Constant>(Op1)); 908 if (!C1) 909 llvm_unreachable("Failed to constant fold udiv -> logbase2"); 910 BinaryOperator *LShr = BinaryOperator::CreateLShr(Op0, C1); 911 if (I.isExact()) 912 LShr->setIsExact(); 913 return LShr; 914 } 915 916 // X udiv (C1 << N), where C1 is "1<<C2" --> X >> (N+C2) 917 // X udiv (zext (C1 << N)), where C1 is "1<<C2" --> X >> (N+C2) 918 static Instruction *foldUDivShl(Value *Op0, Value *Op1, const BinaryOperator &I, 919 InstCombinerImpl &IC) { 920 Value *ShiftLeft; 921 if (!match(Op1, m_ZExt(m_Value(ShiftLeft)))) 922 ShiftLeft = Op1; 923 924 Constant *CI; 925 Value *N; 926 if (!match(ShiftLeft, m_Shl(m_Constant(CI), m_Value(N)))) 927 llvm_unreachable("match should never fail here!"); 928 Constant *Log2Base = ConstantExpr::getExactLogBase2(CI); 929 if (!Log2Base) 930 llvm_unreachable("getLogBase2 should never fail here!"); 931 N = IC.Builder.CreateAdd(N, Log2Base); 932 if (Op1 != ShiftLeft) 933 N = IC.Builder.CreateZExt(N, Op1->getType()); 934 BinaryOperator *LShr = BinaryOperator::CreateLShr(Op0, N); 935 if (I.isExact()) 936 LShr->setIsExact(); 937 return LShr; 938 } 939 940 // Recursively visits the possible right hand operands of a udiv 941 // instruction, seeing through select instructions, to determine if we can 942 // replace the udiv with something simpler. If we find that an operand is not 943 // able to simplify the udiv, we abort the entire transformation. 944 static size_t visitUDivOperand(Value *Op0, Value *Op1, const BinaryOperator &I, 945 SmallVectorImpl<UDivFoldAction> &Actions, 946 unsigned Depth = 0) { 947 // FIXME: assert that Op1 isn't/doesn't contain undef. 948 949 // Check to see if this is an unsigned division with an exact power of 2, 950 // if so, convert to a right shift. 951 if (match(Op1, m_Power2())) { 952 Actions.push_back(UDivFoldAction(foldUDivPow2Cst, Op1)); 953 return Actions.size(); 954 } 955 956 // X udiv (C1 << N), where C1 is "1<<C2" --> X >> (N+C2) 957 if (match(Op1, m_Shl(m_Power2(), m_Value())) || 958 match(Op1, m_ZExt(m_Shl(m_Power2(), m_Value())))) { 959 Actions.push_back(UDivFoldAction(foldUDivShl, Op1)); 960 return Actions.size(); 961 } 962 963 // The remaining tests are all recursive, so bail out if we hit the limit. 964 if (Depth++ == MaxDepth) 965 return 0; 966 967 if (SelectInst *SI = dyn_cast<SelectInst>(Op1)) 968 // FIXME: missed optimization: if one of the hands of select is/contains 969 // undef, just directly pick the other one. 970 // FIXME: can both hands contain undef? 971 if (size_t LHSIdx = 972 visitUDivOperand(Op0, SI->getOperand(1), I, Actions, Depth)) 973 if (visitUDivOperand(Op0, SI->getOperand(2), I, Actions, Depth)) { 974 Actions.push_back(UDivFoldAction(nullptr, Op1, LHSIdx - 1)); 975 return Actions.size(); 976 } 977 978 return 0; 979 } 980 981 /// If we have zero-extended operands of an unsigned div or rem, we may be able 982 /// to narrow the operation (sink the zext below the math). 983 static Instruction *narrowUDivURem(BinaryOperator &I, 984 InstCombiner::BuilderTy &Builder) { 985 Instruction::BinaryOps Opcode = I.getOpcode(); 986 Value *N = I.getOperand(0); 987 Value *D = I.getOperand(1); 988 Type *Ty = I.getType(); 989 Value *X, *Y; 990 if (match(N, m_ZExt(m_Value(X))) && match(D, m_ZExt(m_Value(Y))) && 991 X->getType() == Y->getType() && (N->hasOneUse() || D->hasOneUse())) { 992 // udiv (zext X), (zext Y) --> zext (udiv X, Y) 993 // urem (zext X), (zext Y) --> zext (urem X, Y) 994 Value *NarrowOp = Builder.CreateBinOp(Opcode, X, Y); 995 return new ZExtInst(NarrowOp, Ty); 996 } 997 998 Constant *C; 999 if ((match(N, m_OneUse(m_ZExt(m_Value(X)))) && match(D, m_Constant(C))) || 1000 (match(D, m_OneUse(m_ZExt(m_Value(X)))) && match(N, m_Constant(C)))) { 1001 // If the constant is the same in the smaller type, use the narrow version. 1002 Constant *TruncC = ConstantExpr::getTrunc(C, X->getType()); 1003 if (ConstantExpr::getZExt(TruncC, Ty) != C) 1004 return nullptr; 1005 1006 // udiv (zext X), C --> zext (udiv X, C') 1007 // urem (zext X), C --> zext (urem X, C') 1008 // udiv C, (zext X) --> zext (udiv C', X) 1009 // urem C, (zext X) --> zext (urem C', X) 1010 Value *NarrowOp = isa<Constant>(D) ? Builder.CreateBinOp(Opcode, X, TruncC) 1011 : Builder.CreateBinOp(Opcode, TruncC, X); 1012 return new ZExtInst(NarrowOp, Ty); 1013 } 1014 1015 return nullptr; 1016 } 1017 1018 Instruction *InstCombinerImpl::visitUDiv(BinaryOperator &I) { 1019 if (Value *V = SimplifyUDivInst(I.getOperand(0), I.getOperand(1), 1020 SQ.getWithInstruction(&I))) 1021 return replaceInstUsesWith(I, V); 1022 1023 if (Instruction *X = foldVectorBinop(I)) 1024 return X; 1025 1026 // Handle the integer div common cases 1027 if (Instruction *Common = commonIDivTransforms(I)) 1028 return Common; 1029 1030 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 1031 Value *X; 1032 const APInt *C1, *C2; 1033 if (match(Op0, m_LShr(m_Value(X), m_APInt(C1))) && match(Op1, m_APInt(C2))) { 1034 // (X lshr C1) udiv C2 --> X udiv (C2 << C1) 1035 bool Overflow; 1036 APInt C2ShlC1 = C2->ushl_ov(*C1, Overflow); 1037 if (!Overflow) { 1038 bool IsExact = I.isExact() && match(Op0, m_Exact(m_Value())); 1039 BinaryOperator *BO = BinaryOperator::CreateUDiv( 1040 X, ConstantInt::get(X->getType(), C2ShlC1)); 1041 if (IsExact) 1042 BO->setIsExact(); 1043 return BO; 1044 } 1045 } 1046 1047 // Op0 / C where C is large (negative) --> zext (Op0 >= C) 1048 // TODO: Could use isKnownNegative() to handle non-constant values. 1049 Type *Ty = I.getType(); 1050 if (match(Op1, m_Negative())) { 1051 Value *Cmp = Builder.CreateICmpUGE(Op0, Op1); 1052 return CastInst::CreateZExtOrBitCast(Cmp, Ty); 1053 } 1054 // Op0 / (sext i1 X) --> zext (Op0 == -1) (if X is 0, the div is undefined) 1055 if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)) { 1056 Value *Cmp = Builder.CreateICmpEQ(Op0, ConstantInt::getAllOnesValue(Ty)); 1057 return CastInst::CreateZExtOrBitCast(Cmp, Ty); 1058 } 1059 1060 if (Instruction *NarrowDiv = narrowUDivURem(I, Builder)) 1061 return NarrowDiv; 1062 1063 // If the udiv operands are non-overflowing multiplies with a common operand, 1064 // then eliminate the common factor: 1065 // (A * B) / (A * X) --> B / X (and commuted variants) 1066 // TODO: The code would be reduced if we had m_c_NUWMul pattern matching. 1067 // TODO: If -reassociation handled this generally, we could remove this. 1068 Value *A, *B; 1069 if (match(Op0, m_NUWMul(m_Value(A), m_Value(B)))) { 1070 if (match(Op1, m_NUWMul(m_Specific(A), m_Value(X))) || 1071 match(Op1, m_NUWMul(m_Value(X), m_Specific(A)))) 1072 return BinaryOperator::CreateUDiv(B, X); 1073 if (match(Op1, m_NUWMul(m_Specific(B), m_Value(X))) || 1074 match(Op1, m_NUWMul(m_Value(X), m_Specific(B)))) 1075 return BinaryOperator::CreateUDiv(A, X); 1076 } 1077 1078 // (LHS udiv (select (select (...)))) -> (LHS >> (select (select (...)))) 1079 SmallVector<UDivFoldAction, 6> UDivActions; 1080 if (visitUDivOperand(Op0, Op1, I, UDivActions)) 1081 for (unsigned i = 0, e = UDivActions.size(); i != e; ++i) { 1082 FoldUDivOperandCb Action = UDivActions[i].FoldAction; 1083 Value *ActionOp1 = UDivActions[i].OperandToFold; 1084 Instruction *Inst; 1085 if (Action) 1086 Inst = Action(Op0, ActionOp1, I, *this); 1087 else { 1088 // This action joins two actions together. The RHS of this action is 1089 // simply the last action we processed, we saved the LHS action index in 1090 // the joining action. 1091 size_t SelectRHSIdx = i - 1; 1092 Value *SelectRHS = UDivActions[SelectRHSIdx].FoldResult; 1093 size_t SelectLHSIdx = UDivActions[i].SelectLHSIdx; 1094 Value *SelectLHS = UDivActions[SelectLHSIdx].FoldResult; 1095 Inst = SelectInst::Create(cast<SelectInst>(ActionOp1)->getCondition(), 1096 SelectLHS, SelectRHS); 1097 } 1098 1099 // If this is the last action to process, return it to the InstCombiner. 1100 // Otherwise, we insert it before the UDiv and record it so that we may 1101 // use it as part of a joining action (i.e., a SelectInst). 1102 if (e - i != 1) { 1103 Inst->insertBefore(&I); 1104 UDivActions[i].FoldResult = Inst; 1105 } else 1106 return Inst; 1107 } 1108 1109 return nullptr; 1110 } 1111 1112 Instruction *InstCombinerImpl::visitSDiv(BinaryOperator &I) { 1113 if (Value *V = SimplifySDivInst(I.getOperand(0), I.getOperand(1), 1114 SQ.getWithInstruction(&I))) 1115 return replaceInstUsesWith(I, V); 1116 1117 if (Instruction *X = foldVectorBinop(I)) 1118 return X; 1119 1120 // Handle the integer div common cases 1121 if (Instruction *Common = commonIDivTransforms(I)) 1122 return Common; 1123 1124 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 1125 Type *Ty = I.getType(); 1126 Value *X; 1127 // sdiv Op0, -1 --> -Op0 1128 // sdiv Op0, (sext i1 X) --> -Op0 (because if X is 0, the op is undefined) 1129 if (match(Op1, m_AllOnes()) || 1130 (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))) 1131 return BinaryOperator::CreateNeg(Op0); 1132 1133 // X / INT_MIN --> X == INT_MIN 1134 if (match(Op1, m_SignMask())) 1135 return new ZExtInst(Builder.CreateICmpEQ(Op0, Op1), Ty); 1136 1137 // sdiv exact X, 1<<C --> ashr exact X, C iff 1<<C is non-negative 1138 // sdiv exact X, -1<<C --> -(ashr exact X, C) 1139 if (I.isExact() && ((match(Op1, m_Power2()) && match(Op1, m_NonNegative())) || 1140 match(Op1, m_NegatedPower2()))) { 1141 bool DivisorWasNegative = match(Op1, m_NegatedPower2()); 1142 if (DivisorWasNegative) 1143 Op1 = ConstantExpr::getNeg(cast<Constant>(Op1)); 1144 auto *AShr = BinaryOperator::CreateExactAShr( 1145 Op0, ConstantExpr::getExactLogBase2(cast<Constant>(Op1)), I.getName()); 1146 if (!DivisorWasNegative) 1147 return AShr; 1148 Builder.Insert(AShr); 1149 AShr->setName(I.getName() + ".neg"); 1150 return BinaryOperator::CreateNeg(AShr, I.getName()); 1151 } 1152 1153 const APInt *Op1C; 1154 if (match(Op1, m_APInt(Op1C))) { 1155 // If the dividend is sign-extended and the constant divisor is small enough 1156 // to fit in the source type, shrink the division to the narrower type: 1157 // (sext X) sdiv C --> sext (X sdiv C) 1158 Value *Op0Src; 1159 if (match(Op0, m_OneUse(m_SExt(m_Value(Op0Src)))) && 1160 Op0Src->getType()->getScalarSizeInBits() >= Op1C->getMinSignedBits()) { 1161 1162 // In the general case, we need to make sure that the dividend is not the 1163 // minimum signed value because dividing that by -1 is UB. But here, we 1164 // know that the -1 divisor case is already handled above. 1165 1166 Constant *NarrowDivisor = 1167 ConstantExpr::getTrunc(cast<Constant>(Op1), Op0Src->getType()); 1168 Value *NarrowOp = Builder.CreateSDiv(Op0Src, NarrowDivisor); 1169 return new SExtInst(NarrowOp, Ty); 1170 } 1171 1172 // -X / C --> X / -C (if the negation doesn't overflow). 1173 // TODO: This could be enhanced to handle arbitrary vector constants by 1174 // checking if all elements are not the min-signed-val. 1175 if (!Op1C->isMinSignedValue() && 1176 match(Op0, m_NSWSub(m_Zero(), m_Value(X)))) { 1177 Constant *NegC = ConstantInt::get(Ty, -(*Op1C)); 1178 Instruction *BO = BinaryOperator::CreateSDiv(X, NegC); 1179 BO->setIsExact(I.isExact()); 1180 return BO; 1181 } 1182 } 1183 1184 // -X / Y --> -(X / Y) 1185 Value *Y; 1186 if (match(&I, m_SDiv(m_OneUse(m_NSWSub(m_Zero(), m_Value(X))), m_Value(Y)))) 1187 return BinaryOperator::CreateNSWNeg( 1188 Builder.CreateSDiv(X, Y, I.getName(), I.isExact())); 1189 1190 // abs(X) / X --> X > -1 ? 1 : -1 1191 // X / abs(X) --> X > -1 ? 1 : -1 1192 if (match(&I, m_c_BinOp( 1193 m_OneUse(m_Intrinsic<Intrinsic::abs>(m_Value(X), m_One())), 1194 m_Deferred(X)))) { 1195 Constant *NegOne = ConstantInt::getAllOnesValue(Ty); 1196 Value *Cond = Builder.CreateICmpSGT(X, NegOne); 1197 return SelectInst::Create(Cond, ConstantInt::get(Ty, 1), NegOne); 1198 } 1199 1200 // If the sign bits of both operands are zero (i.e. we can prove they are 1201 // unsigned inputs), turn this into a udiv. 1202 APInt Mask(APInt::getSignMask(Ty->getScalarSizeInBits())); 1203 if (MaskedValueIsZero(Op0, Mask, 0, &I)) { 1204 if (MaskedValueIsZero(Op1, Mask, 0, &I)) { 1205 // X sdiv Y -> X udiv Y, iff X and Y don't have sign bit set 1206 auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName()); 1207 BO->setIsExact(I.isExact()); 1208 return BO; 1209 } 1210 1211 if (match(Op1, m_NegatedPower2())) { 1212 // X sdiv (-(1 << C)) -> -(X sdiv (1 << C)) -> 1213 // -> -(X udiv (1 << C)) -> -(X u>> C) 1214 return BinaryOperator::CreateNeg(Builder.Insert(foldUDivPow2Cst( 1215 Op0, ConstantExpr::getNeg(cast<Constant>(Op1)), I, *this))); 1216 } 1217 1218 if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/ true, 0, &I)) { 1219 // X sdiv (1 << Y) -> X udiv (1 << Y) ( -> X u>> Y) 1220 // Safe because the only negative value (1 << Y) can take on is 1221 // INT_MIN, and X sdiv INT_MIN == X udiv INT_MIN == 0 if X doesn't have 1222 // the sign bit set. 1223 auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName()); 1224 BO->setIsExact(I.isExact()); 1225 return BO; 1226 } 1227 } 1228 1229 return nullptr; 1230 } 1231 1232 /// Remove negation and try to convert division into multiplication. 1233 static Instruction *foldFDivConstantDivisor(BinaryOperator &I) { 1234 Constant *C; 1235 if (!match(I.getOperand(1), m_Constant(C))) 1236 return nullptr; 1237 1238 // -X / C --> X / -C 1239 Value *X; 1240 if (match(I.getOperand(0), m_FNeg(m_Value(X)))) 1241 return BinaryOperator::CreateFDivFMF(X, ConstantExpr::getFNeg(C), &I); 1242 1243 // If the constant divisor has an exact inverse, this is always safe. If not, 1244 // then we can still create a reciprocal if fast-math-flags allow it and the 1245 // constant is a regular number (not zero, infinite, or denormal). 1246 if (!(C->hasExactInverseFP() || (I.hasAllowReciprocal() && C->isNormalFP()))) 1247 return nullptr; 1248 1249 // Disallow denormal constants because we don't know what would happen 1250 // on all targets. 1251 // TODO: Use Intrinsic::canonicalize or let function attributes tell us that 1252 // denorms are flushed? 1253 auto *RecipC = ConstantExpr::getFDiv(ConstantFP::get(I.getType(), 1.0), C); 1254 if (!RecipC->isNormalFP()) 1255 return nullptr; 1256 1257 // X / C --> X * (1 / C) 1258 return BinaryOperator::CreateFMulFMF(I.getOperand(0), RecipC, &I); 1259 } 1260 1261 /// Remove negation and try to reassociate constant math. 1262 static Instruction *foldFDivConstantDividend(BinaryOperator &I) { 1263 Constant *C; 1264 if (!match(I.getOperand(0), m_Constant(C))) 1265 return nullptr; 1266 1267 // C / -X --> -C / X 1268 Value *X; 1269 if (match(I.getOperand(1), m_FNeg(m_Value(X)))) 1270 return BinaryOperator::CreateFDivFMF(ConstantExpr::getFNeg(C), X, &I); 1271 1272 if (!I.hasAllowReassoc() || !I.hasAllowReciprocal()) 1273 return nullptr; 1274 1275 // Try to reassociate C / X expressions where X includes another constant. 1276 Constant *C2, *NewC = nullptr; 1277 if (match(I.getOperand(1), m_FMul(m_Value(X), m_Constant(C2)))) { 1278 // C / (X * C2) --> (C / C2) / X 1279 NewC = ConstantExpr::getFDiv(C, C2); 1280 } else if (match(I.getOperand(1), m_FDiv(m_Value(X), m_Constant(C2)))) { 1281 // C / (X / C2) --> (C * C2) / X 1282 NewC = ConstantExpr::getFMul(C, C2); 1283 } 1284 // Disallow denormal constants because we don't know what would happen 1285 // on all targets. 1286 // TODO: Use Intrinsic::canonicalize or let function attributes tell us that 1287 // denorms are flushed? 1288 if (!NewC || !NewC->isNormalFP()) 1289 return nullptr; 1290 1291 return BinaryOperator::CreateFDivFMF(NewC, X, &I); 1292 } 1293 1294 /// Negate the exponent of pow/exp to fold division-by-pow() into multiply. 1295 static Instruction *foldFDivPowDivisor(BinaryOperator &I, 1296 InstCombiner::BuilderTy &Builder) { 1297 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 1298 auto *II = dyn_cast<IntrinsicInst>(Op1); 1299 if (!II || !II->hasOneUse() || !I.hasAllowReassoc() || 1300 !I.hasAllowReciprocal()) 1301 return nullptr; 1302 1303 // Z / pow(X, Y) --> Z * pow(X, -Y) 1304 // Z / exp{2}(Y) --> Z * exp{2}(-Y) 1305 // In the general case, this creates an extra instruction, but fmul allows 1306 // for better canonicalization and optimization than fdiv. 1307 Intrinsic::ID IID = II->getIntrinsicID(); 1308 SmallVector<Value *> Args; 1309 switch (IID) { 1310 case Intrinsic::pow: 1311 Args.push_back(II->getArgOperand(0)); 1312 Args.push_back(Builder.CreateFNegFMF(II->getArgOperand(1), &I)); 1313 break; 1314 case Intrinsic::powi: { 1315 // Require 'ninf' assuming that makes powi(X, -INT_MIN) acceptable. 1316 // That is, X ** (huge negative number) is 0.0, ~1.0, or INF and so 1317 // dividing by that is INF, ~1.0, or 0.0. Code that uses powi allows 1318 // non-standard results, so this corner case should be acceptable if the 1319 // code rules out INF values. 1320 if (!I.hasNoInfs()) 1321 return nullptr; 1322 Args.push_back(II->getArgOperand(0)); 1323 Args.push_back(Builder.CreateNeg(II->getArgOperand(1))); 1324 Type *Tys[] = {I.getType(), II->getArgOperand(1)->getType()}; 1325 Value *Pow = Builder.CreateIntrinsic(IID, Tys, Args, &I); 1326 return BinaryOperator::CreateFMulFMF(Op0, Pow, &I); 1327 } 1328 case Intrinsic::exp: 1329 case Intrinsic::exp2: 1330 Args.push_back(Builder.CreateFNegFMF(II->getArgOperand(0), &I)); 1331 break; 1332 default: 1333 return nullptr; 1334 } 1335 Value *Pow = Builder.CreateIntrinsic(IID, I.getType(), Args, &I); 1336 return BinaryOperator::CreateFMulFMF(Op0, Pow, &I); 1337 } 1338 1339 Instruction *InstCombinerImpl::visitFDiv(BinaryOperator &I) { 1340 if (Value *V = SimplifyFDivInst(I.getOperand(0), I.getOperand(1), 1341 I.getFastMathFlags(), 1342 SQ.getWithInstruction(&I))) 1343 return replaceInstUsesWith(I, V); 1344 1345 if (Instruction *X = foldVectorBinop(I)) 1346 return X; 1347 1348 if (Instruction *R = foldFDivConstantDivisor(I)) 1349 return R; 1350 1351 if (Instruction *R = foldFDivConstantDividend(I)) 1352 return R; 1353 1354 if (Instruction *R = foldFPSignBitOps(I)) 1355 return R; 1356 1357 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 1358 if (isa<Constant>(Op0)) 1359 if (SelectInst *SI = dyn_cast<SelectInst>(Op1)) 1360 if (Instruction *R = FoldOpIntoSelect(I, SI)) 1361 return R; 1362 1363 if (isa<Constant>(Op1)) 1364 if (SelectInst *SI = dyn_cast<SelectInst>(Op0)) 1365 if (Instruction *R = FoldOpIntoSelect(I, SI)) 1366 return R; 1367 1368 if (I.hasAllowReassoc() && I.hasAllowReciprocal()) { 1369 Value *X, *Y; 1370 if (match(Op0, m_OneUse(m_FDiv(m_Value(X), m_Value(Y)))) && 1371 (!isa<Constant>(Y) || !isa<Constant>(Op1))) { 1372 // (X / Y) / Z => X / (Y * Z) 1373 Value *YZ = Builder.CreateFMulFMF(Y, Op1, &I); 1374 return BinaryOperator::CreateFDivFMF(X, YZ, &I); 1375 } 1376 if (match(Op1, m_OneUse(m_FDiv(m_Value(X), m_Value(Y)))) && 1377 (!isa<Constant>(Y) || !isa<Constant>(Op0))) { 1378 // Z / (X / Y) => (Y * Z) / X 1379 Value *YZ = Builder.CreateFMulFMF(Y, Op0, &I); 1380 return BinaryOperator::CreateFDivFMF(YZ, X, &I); 1381 } 1382 // Z / (1.0 / Y) => (Y * Z) 1383 // 1384 // This is a special case of Z / (X / Y) => (Y * Z) / X, with X = 1.0. The 1385 // m_OneUse check is avoided because even in the case of the multiple uses 1386 // for 1.0/Y, the number of instructions remain the same and a division is 1387 // replaced by a multiplication. 1388 if (match(Op1, m_FDiv(m_SpecificFP(1.0), m_Value(Y)))) 1389 return BinaryOperator::CreateFMulFMF(Y, Op0, &I); 1390 } 1391 1392 if (I.hasAllowReassoc() && Op0->hasOneUse() && Op1->hasOneUse()) { 1393 // sin(X) / cos(X) -> tan(X) 1394 // cos(X) / sin(X) -> 1/tan(X) (cotangent) 1395 Value *X; 1396 bool IsTan = match(Op0, m_Intrinsic<Intrinsic::sin>(m_Value(X))) && 1397 match(Op1, m_Intrinsic<Intrinsic::cos>(m_Specific(X))); 1398 bool IsCot = 1399 !IsTan && match(Op0, m_Intrinsic<Intrinsic::cos>(m_Value(X))) && 1400 match(Op1, m_Intrinsic<Intrinsic::sin>(m_Specific(X))); 1401 1402 if ((IsTan || IsCot) && 1403 hasFloatFn(&TLI, I.getType(), LibFunc_tan, LibFunc_tanf, LibFunc_tanl)) { 1404 IRBuilder<> B(&I); 1405 IRBuilder<>::FastMathFlagGuard FMFGuard(B); 1406 B.setFastMathFlags(I.getFastMathFlags()); 1407 AttributeList Attrs = 1408 cast<CallBase>(Op0)->getCalledFunction()->getAttributes(); 1409 Value *Res = emitUnaryFloatFnCall(X, &TLI, LibFunc_tan, LibFunc_tanf, 1410 LibFunc_tanl, B, Attrs); 1411 if (IsCot) 1412 Res = B.CreateFDiv(ConstantFP::get(I.getType(), 1.0), Res); 1413 return replaceInstUsesWith(I, Res); 1414 } 1415 } 1416 1417 // X / (X * Y) --> 1.0 / Y 1418 // Reassociate to (X / X -> 1.0) is legal when NaNs are not allowed. 1419 // We can ignore the possibility that X is infinity because INF/INF is NaN. 1420 Value *X, *Y; 1421 if (I.hasNoNaNs() && I.hasAllowReassoc() && 1422 match(Op1, m_c_FMul(m_Specific(Op0), m_Value(Y)))) { 1423 replaceOperand(I, 0, ConstantFP::get(I.getType(), 1.0)); 1424 replaceOperand(I, 1, Y); 1425 return &I; 1426 } 1427 1428 // X / fabs(X) -> copysign(1.0, X) 1429 // fabs(X) / X -> copysign(1.0, X) 1430 if (I.hasNoNaNs() && I.hasNoInfs() && 1431 (match(&I, m_FDiv(m_Value(X), m_FAbs(m_Deferred(X)))) || 1432 match(&I, m_FDiv(m_FAbs(m_Value(X)), m_Deferred(X))))) { 1433 Value *V = Builder.CreateBinaryIntrinsic( 1434 Intrinsic::copysign, ConstantFP::get(I.getType(), 1.0), X, &I); 1435 return replaceInstUsesWith(I, V); 1436 } 1437 1438 if (Instruction *Mul = foldFDivPowDivisor(I, Builder)) 1439 return Mul; 1440 1441 return nullptr; 1442 } 1443 1444 /// This function implements the transforms common to both integer remainder 1445 /// instructions (urem and srem). It is called by the visitors to those integer 1446 /// remainder instructions. 1447 /// Common integer remainder transforms 1448 Instruction *InstCombinerImpl::commonIRemTransforms(BinaryOperator &I) { 1449 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 1450 1451 // The RHS is known non-zero. 1452 if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I)) 1453 return replaceOperand(I, 1, V); 1454 1455 // Handle cases involving: rem X, (select Cond, Y, Z) 1456 if (simplifyDivRemOfSelectWithZeroOp(I)) 1457 return &I; 1458 1459 if (isa<Constant>(Op1)) { 1460 if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) { 1461 if (SelectInst *SI = dyn_cast<SelectInst>(Op0I)) { 1462 if (Instruction *R = FoldOpIntoSelect(I, SI)) 1463 return R; 1464 } else if (auto *PN = dyn_cast<PHINode>(Op0I)) { 1465 const APInt *Op1Int; 1466 if (match(Op1, m_APInt(Op1Int)) && !Op1Int->isMinValue() && 1467 (I.getOpcode() == Instruction::URem || 1468 !Op1Int->isMinSignedValue())) { 1469 // foldOpIntoPhi will speculate instructions to the end of the PHI's 1470 // predecessor blocks, so do this only if we know the srem or urem 1471 // will not fault. 1472 if (Instruction *NV = foldOpIntoPhi(I, PN)) 1473 return NV; 1474 } 1475 } 1476 1477 // See if we can fold away this rem instruction. 1478 if (SimplifyDemandedInstructionBits(I)) 1479 return &I; 1480 } 1481 } 1482 1483 return nullptr; 1484 } 1485 1486 Instruction *InstCombinerImpl::visitURem(BinaryOperator &I) { 1487 if (Value *V = SimplifyURemInst(I.getOperand(0), I.getOperand(1), 1488 SQ.getWithInstruction(&I))) 1489 return replaceInstUsesWith(I, V); 1490 1491 if (Instruction *X = foldVectorBinop(I)) 1492 return X; 1493 1494 if (Instruction *common = commonIRemTransforms(I)) 1495 return common; 1496 1497 if (Instruction *NarrowRem = narrowUDivURem(I, Builder)) 1498 return NarrowRem; 1499 1500 // X urem Y -> X and Y-1, where Y is a power of 2, 1501 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 1502 Type *Ty = I.getType(); 1503 if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/ true, 0, &I)) { 1504 // This may increase instruction count, we don't enforce that Y is a 1505 // constant. 1506 Constant *N1 = Constant::getAllOnesValue(Ty); 1507 Value *Add = Builder.CreateAdd(Op1, N1); 1508 return BinaryOperator::CreateAnd(Op0, Add); 1509 } 1510 1511 // 1 urem X -> zext(X != 1) 1512 if (match(Op0, m_One())) { 1513 Value *Cmp = Builder.CreateICmpNE(Op1, ConstantInt::get(Ty, 1)); 1514 return CastInst::CreateZExtOrBitCast(Cmp, Ty); 1515 } 1516 1517 // X urem C -> X < C ? X : X - C, where C >= signbit. 1518 if (match(Op1, m_Negative())) { 1519 Value *Cmp = Builder.CreateICmpULT(Op0, Op1); 1520 Value *Sub = Builder.CreateSub(Op0, Op1); 1521 return SelectInst::Create(Cmp, Op0, Sub); 1522 } 1523 1524 // If the divisor is a sext of a boolean, then the divisor must be max 1525 // unsigned value (-1). Therefore, the remainder is Op0 unless Op0 is also 1526 // max unsigned value. In that case, the remainder is 0: 1527 // urem Op0, (sext i1 X) --> (Op0 == -1) ? 0 : Op0 1528 Value *X; 1529 if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)) { 1530 Value *Cmp = Builder.CreateICmpEQ(Op0, ConstantInt::getAllOnesValue(Ty)); 1531 return SelectInst::Create(Cmp, ConstantInt::getNullValue(Ty), Op0); 1532 } 1533 1534 return nullptr; 1535 } 1536 1537 Instruction *InstCombinerImpl::visitSRem(BinaryOperator &I) { 1538 if (Value *V = SimplifySRemInst(I.getOperand(0), I.getOperand(1), 1539 SQ.getWithInstruction(&I))) 1540 return replaceInstUsesWith(I, V); 1541 1542 if (Instruction *X = foldVectorBinop(I)) 1543 return X; 1544 1545 // Handle the integer rem common cases 1546 if (Instruction *Common = commonIRemTransforms(I)) 1547 return Common; 1548 1549 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 1550 { 1551 const APInt *Y; 1552 // X % -Y -> X % Y 1553 if (match(Op1, m_Negative(Y)) && !Y->isMinSignedValue()) 1554 return replaceOperand(I, 1, ConstantInt::get(I.getType(), -*Y)); 1555 } 1556 1557 // -X srem Y --> -(X srem Y) 1558 Value *X, *Y; 1559 if (match(&I, m_SRem(m_OneUse(m_NSWSub(m_Zero(), m_Value(X))), m_Value(Y)))) 1560 return BinaryOperator::CreateNSWNeg(Builder.CreateSRem(X, Y)); 1561 1562 // If the sign bits of both operands are zero (i.e. we can prove they are 1563 // unsigned inputs), turn this into a urem. 1564 APInt Mask(APInt::getSignMask(I.getType()->getScalarSizeInBits())); 1565 if (MaskedValueIsZero(Op1, Mask, 0, &I) && 1566 MaskedValueIsZero(Op0, Mask, 0, &I)) { 1567 // X srem Y -> X urem Y, iff X and Y don't have sign bit set 1568 return BinaryOperator::CreateURem(Op0, Op1, I.getName()); 1569 } 1570 1571 // If it's a constant vector, flip any negative values positive. 1572 if (isa<ConstantVector>(Op1) || isa<ConstantDataVector>(Op1)) { 1573 Constant *C = cast<Constant>(Op1); 1574 unsigned VWidth = cast<FixedVectorType>(C->getType())->getNumElements(); 1575 1576 bool hasNegative = false; 1577 bool hasMissing = false; 1578 for (unsigned i = 0; i != VWidth; ++i) { 1579 Constant *Elt = C->getAggregateElement(i); 1580 if (!Elt) { 1581 hasMissing = true; 1582 break; 1583 } 1584 1585 if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elt)) 1586 if (RHS->isNegative()) 1587 hasNegative = true; 1588 } 1589 1590 if (hasNegative && !hasMissing) { 1591 SmallVector<Constant *, 16> Elts(VWidth); 1592 for (unsigned i = 0; i != VWidth; ++i) { 1593 Elts[i] = C->getAggregateElement(i); // Handle undef, etc. 1594 if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elts[i])) { 1595 if (RHS->isNegative()) 1596 Elts[i] = cast<ConstantInt>(ConstantExpr::getNeg(RHS)); 1597 } 1598 } 1599 1600 Constant *NewRHSV = ConstantVector::get(Elts); 1601 if (NewRHSV != C) // Don't loop on -MININT 1602 return replaceOperand(I, 1, NewRHSV); 1603 } 1604 } 1605 1606 return nullptr; 1607 } 1608 1609 Instruction *InstCombinerImpl::visitFRem(BinaryOperator &I) { 1610 if (Value *V = SimplifyFRemInst(I.getOperand(0), I.getOperand(1), 1611 I.getFastMathFlags(), 1612 SQ.getWithInstruction(&I))) 1613 return replaceInstUsesWith(I, V); 1614 1615 if (Instruction *X = foldVectorBinop(I)) 1616 return X; 1617 1618 return nullptr; 1619 } 1620