blob: 4cc2cbc493ffcd0b02c7221331dd8fb4acd81d7c [file] [log] [blame]
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001//===- InstCombineMulDivRem.cpp -------------------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the visit functions for mul, fmul, sdiv, udiv, fdiv,
11// srem, urem, frem.
12//
13//===----------------------------------------------------------------------===//
14
Chandler Carrutha9174582015-01-22 05:25:13 +000015#include "InstCombineInternal.h"
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +000016#include "llvm/ADT/APFloat.h"
17#include "llvm/ADT/APInt.h"
18#include "llvm/ADT/SmallVector.h"
Duncan Sandsd0eb6d32010-12-21 14:00:22 +000019#include "llvm/Analysis/InstructionSimplify.h"
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +000020#include "llvm/IR/BasicBlock.h"
21#include "llvm/IR/Constant.h"
22#include "llvm/IR/Constants.h"
23#include "llvm/IR/InstrTypes.h"
24#include "llvm/IR/Instruction.h"
25#include "llvm/IR/Instructions.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000026#include "llvm/IR/IntrinsicInst.h"
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +000027#include "llvm/IR/Intrinsics.h"
28#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000029#include "llvm/IR/PatternMatch.h"
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +000030#include "llvm/IR/Type.h"
31#include "llvm/IR/Value.h"
32#include "llvm/Support/Casting.h"
33#include "llvm/Support/ErrorHandling.h"
34#include "llvm/Support/KnownBits.h"
35#include "llvm/Transforms/InstCombine/InstCombineWorklist.h"
Dmitry Venikove5fbf592018-01-11 06:33:00 +000036#include "llvm/Transforms/Utils/BuildLibCalls.h"
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +000037#include <cassert>
38#include <cstddef>
39#include <cstdint>
40#include <utility>
41
Chris Lattnerdc054bf2010-01-05 06:09:35 +000042using namespace llvm;
43using namespace PatternMatch;
44
Chandler Carruth964daaa2014-04-22 02:55:47 +000045#define DEBUG_TYPE "instcombine"
46
Sanjay Patel6eccf482015-09-09 15:24:36 +000047/// 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.
Hal Finkel60db0582014-09-07 18:57:58 +000050static Value *simplifyValueKnownNonZero(Value *V, InstCombiner &IC,
Mehdi Aminia28d91d2015-03-10 02:37:25 +000051 Instruction &CxtI) {
Chris Lattner7c99f192011-05-22 18:18:41 +000052 // 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.
Craig Topperf40110f2014-04-25 05:29:35 +000055 if (!V->hasOneUse()) return nullptr;
Jim Grosbachbdbd7342013-04-05 21:20:12 +000056
Chris Lattner388cb8a2011-05-23 00:32:19 +000057 bool MadeChange = false;
58
Chris Lattner7c99f192011-05-22 18:18:41 +000059 // ((1 << A) >>u B) --> (1 << (A-B))
60 // Because V cannot be zero, we know that B is less than A.
David Majnemerdad21032014-10-14 20:28:40 +000061 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())) {
Craig Topperbb4069e2017-07-07 23:16:26 +000064 A = IC.Builder.CreateSub(A, B);
65 return IC.Builder.CreateShl(One, A);
Chris Lattner7c99f192011-05-22 18:18:41 +000066 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +000067
Chris Lattner388cb8a2011-05-23 00:32:19 +000068 // (PowerOfTwo >>u B) --> isExact since shifting out the result would make it
69 // inexact. Similarly for <<.
Sanjay Patela8ef4a52016-05-22 17:08:52 +000070 BinaryOperator *I = dyn_cast<BinaryOperator>(V);
71 if (I && I->isLogicalShift() &&
Craig Topperd4039f72017-05-25 21:51:12 +000072 IC.isKnownToBeAPowerOfTwo(I->getOperand(0), false, 0, &CxtI)) {
Sanjay Patela8ef4a52016-05-22 17:08:52 +000073 // 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 I->setOperand(0, V2);
77 MadeChange = true;
Chris Lattner388cb8a2011-05-23 00:32:19 +000078 }
79
Sanjay Patela8ef4a52016-05-22 17:08:52 +000080 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
Chris Lattner162dfc32011-05-22 18:26:48 +000091 // TODO: Lots more we could do here:
Chris Lattner162dfc32011-05-22 18:26:48 +000092 // If V is a phi node, we can call this on each of its operands.
93 // "select cond, X, 0" can simplify to "X".
Jim Grosbachbdbd7342013-04-05 21:20:12 +000094
Craig Topperf40110f2014-04-25 05:29:35 +000095 return MadeChange ? V : nullptr;
Chris Lattner7c99f192011-05-22 18:18:41 +000096}
97
Rafael Espindola65281bf2013-05-31 14:27:15 +000098/// \brief A helper routine of InstCombiner::visitMul().
99///
Simon Pilgrim0b9f3912018-02-08 14:10:01 +0000100/// If C is a scalar/vector of known powers of 2, then this function returns
101/// a new scalar/vector obtained from logBase2 of C.
Rafael Espindola65281bf2013-05-31 14:27:15 +0000102/// Return a null pointer otherwise.
Simon Pilgrim0b9f3912018-02-08 14:10:01 +0000103static Constant *getLogBase2(Type *Ty, Constant *C) {
Rafael Espindola65281bf2013-05-31 14:27:15 +0000104 const APInt *IVal;
Simon Pilgrimbe0dd722018-02-13 13:16:26 +0000105 if (match(C, m_APInt(IVal)) && IVal->isPowerOf2())
106 return ConstantInt::get(Ty, IVal->logBase2());
Rafael Espindola65281bf2013-05-31 14:27:15 +0000107
Simon Pilgrim0b9f3912018-02-08 14:10:01 +0000108 if (!Ty->isVectorTy())
109 return nullptr;
110
111 SmallVector<Constant *, 4> Elts;
112 for (unsigned I = 0, E = Ty->getVectorNumElements(); I != E; ++I) {
113 Constant *Elt = C->getAggregateElement(I);
114 if (!Elt)
115 return nullptr;
116 if (isa<UndefValue>(Elt)) {
117 Elts.push_back(UndefValue::get(Ty->getScalarType()));
118 continue;
119 }
Rafael Espindola65281bf2013-05-31 14:27:15 +0000120 if (!match(Elt, m_APInt(IVal)) || !IVal->isPowerOf2())
Craig Topperf40110f2014-04-25 05:29:35 +0000121 return nullptr;
Simon Pilgrim0b9f3912018-02-08 14:10:01 +0000122 Elts.push_back(ConstantInt::get(Ty->getScalarType(), IVal->logBase2()));
Rafael Espindola65281bf2013-05-31 14:27:15 +0000123 }
124
125 return ConstantVector::get(Elts);
126}
127
David Majnemer54c2ca22014-12-26 09:10:14 +0000128/// \brief Return true if we can prove that:
129/// (mul LHS, RHS) === (mul nsw LHS, RHS)
Craig Topper2b1fc322017-05-22 06:25:31 +0000130bool InstCombiner::willNotOverflowSignedMul(const Value *LHS,
131 const Value *RHS,
132 const Instruction &CxtI) const {
David Majnemer54c2ca22014-12-26 09:10:14 +0000133 // Multiplying n * m significant bits yields a result of n + m significant
134 // bits. If the total number of significant bits does not exceed the
135 // result bit width (minus 1), there is no overflow.
136 // This means if we have enough leading sign bits in the operands
137 // we can guarantee that the result does not overflow.
138 // Ref: "Hacker's Delight" by Henry Warren
139 unsigned BitWidth = LHS->getType()->getScalarSizeInBits();
140
141 // Note that underestimating the number of sign bits gives a more
142 // conservative answer.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000143 unsigned SignBits =
144 ComputeNumSignBits(LHS, 0, &CxtI) + ComputeNumSignBits(RHS, 0, &CxtI);
David Majnemer54c2ca22014-12-26 09:10:14 +0000145
146 // First handle the easy case: if we have enough sign bits there's
147 // definitely no overflow.
148 if (SignBits > BitWidth + 1)
149 return true;
150
151 // There are two ambiguous cases where there can be no overflow:
152 // SignBits == BitWidth + 1 and
153 // SignBits == BitWidth
154 // The second case is difficult to check, therefore we only handle the
155 // first case.
156 if (SignBits == BitWidth + 1) {
157 // It overflows only when both arguments are negative and the true
158 // product is exactly the minimum negative number.
159 // E.g. mul i16 with 17 sign bits: 0xff00 * 0xff80 = 0x8000
160 // For simplicity we just check if at least one side is not negative.
Craig Topper1a36b7d2017-05-15 06:39:41 +0000161 KnownBits LHSKnown = computeKnownBits(LHS, /*Depth=*/0, &CxtI);
162 KnownBits RHSKnown = computeKnownBits(RHS, /*Depth=*/0, &CxtI);
163 if (LHSKnown.isNonNegative() || RHSKnown.isNonNegative())
David Majnemer54c2ca22014-12-26 09:10:14 +0000164 return true;
165 }
166 return false;
167}
168
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000169Instruction *InstCombiner::visitMul(BinaryOperator &I) {
Duncan Sands641baf12010-11-13 15:10:37 +0000170 bool Changed = SimplifyAssociativeOrCommutative(I);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000171 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
172
Serge Pavlov9ef66a82014-05-11 08:46:12 +0000173 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +0000174 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +0000175
Craig Toppera4205622017-06-09 03:21:29 +0000176 if (Value *V = SimplifyMulInst(Op0, Op1, SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +0000177 return replaceInstUsesWith(I, V);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000178
Duncan Sandsfbb9ac32010-12-22 13:36:08 +0000179 if (Value *V = SimplifyUsingDistributiveLaws(I))
Sanjay Patel4b198802016-02-01 22:23:39 +0000180 return replaceInstUsesWith(I, V);
Duncan Sandsfbb9ac32010-12-22 13:36:08 +0000181
David Majnemer027bc802014-11-22 04:52:38 +0000182 // X * -1 == 0 - X
183 if (match(Op1, m_AllOnes())) {
184 BinaryOperator *BO = BinaryOperator::CreateNeg(Op0, I.getName());
185 if (I.hasNoSignedWrap())
186 BO->setHasNoSignedWrap();
187 return BO;
188 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000189
Rafael Espindola65281bf2013-05-31 14:27:15 +0000190 // Also allow combining multiply instructions on vectors.
191 {
192 Value *NewOp;
193 Constant *C1, *C2;
194 const APInt *IVal;
195 if (match(&I, m_Mul(m_Shl(m_Value(NewOp), m_Constant(C2)),
196 m_Constant(C1))) &&
David Majnemerfd4a6d22014-11-22 04:52:52 +0000197 match(C1, m_APInt(IVal))) {
198 // ((X << C2)*C1) == (X * (C1 << C2))
199 Constant *Shl = ConstantExpr::getShl(C1, C2);
200 BinaryOperator *Mul = cast<BinaryOperator>(I.getOperand(0));
201 BinaryOperator *BO = BinaryOperator::CreateMul(NewOp, Shl);
202 if (I.hasNoUnsignedWrap() && Mul->hasNoUnsignedWrap())
203 BO->setHasNoUnsignedWrap();
204 if (I.hasNoSignedWrap() && Mul->hasNoSignedWrap() &&
205 Shl->isNotMinSignedValue())
206 BO->setHasNoSignedWrap();
207 return BO;
208 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000209
Rafael Espindola65281bf2013-05-31 14:27:15 +0000210 if (match(&I, m_Mul(m_Value(NewOp), m_Constant(C1)))) {
Simon Pilgrim0b9f3912018-02-08 14:10:01 +0000211 // Replace X*(2^C) with X << C, where C is either a scalar or a vector.
212 if (Constant *NewCst = getLogBase2(NewOp->getType(), C1)) {
David Majnemer45951a62015-04-18 04:41:30 +0000213 unsigned Width = NewCst->getType()->getPrimitiveSizeInBits();
Rafael Espindola65281bf2013-05-31 14:27:15 +0000214 BinaryOperator *Shl = BinaryOperator::CreateShl(NewOp, NewCst);
Tilmann Scheller2bc5cb62014-10-07 10:19:34 +0000215
Tilmann Scheller2bc5cb62014-10-07 10:19:34 +0000216 if (I.hasNoUnsignedWrap())
217 Shl->setHasNoUnsignedWrap();
David Majnemer45951a62015-04-18 04:41:30 +0000218 if (I.hasNoSignedWrap()) {
Craig Topper5fe01972017-06-27 19:57:53 +0000219 const APInt *V;
220 if (match(NewCst, m_APInt(V)) && *V != Width - 1)
David Majnemer45951a62015-04-18 04:41:30 +0000221 Shl->setHasNoSignedWrap();
222 }
Tilmann Scheller2bc5cb62014-10-07 10:19:34 +0000223
Rafael Espindola65281bf2013-05-31 14:27:15 +0000224 return Shl;
225 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000226 }
Rafael Espindola65281bf2013-05-31 14:27:15 +0000227 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000228
Rafael Espindola65281bf2013-05-31 14:27:15 +0000229 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Stuart Hastings23804832011-06-01 16:42:47 +0000230 // (Y - X) * (-(2**n)) -> (X - Y) * (2**n), for positive nonzero n
231 // (Y + const) * (-(2**n)) -> (-constY) * (2**n), for positive nonzero n
232 // The "* (2**n)" thus becomes a potential shifting opportunity.
Stuart Hastings82843742011-05-30 20:00:33 +0000233 {
234 const APInt & Val = CI->getValue();
235 const APInt &PosVal = Val.abs();
236 if (Val.isNegative() && PosVal.isPowerOf2()) {
Craig Topperf40110f2014-04-25 05:29:35 +0000237 Value *X = nullptr, *Y = nullptr;
Stuart Hastings23804832011-06-01 16:42:47 +0000238 if (Op0->hasOneUse()) {
239 ConstantInt *C1;
Craig Topperf40110f2014-04-25 05:29:35 +0000240 Value *Sub = nullptr;
Stuart Hastings23804832011-06-01 16:42:47 +0000241 if (match(Op0, m_Sub(m_Value(Y), m_Value(X))))
Craig Topperbb4069e2017-07-07 23:16:26 +0000242 Sub = Builder.CreateSub(X, Y, "suba");
Stuart Hastings23804832011-06-01 16:42:47 +0000243 else if (match(Op0, m_Add(m_Value(Y), m_ConstantInt(C1))))
Craig Topperbb4069e2017-07-07 23:16:26 +0000244 Sub = Builder.CreateSub(Builder.CreateNeg(C1), Y, "subc");
Stuart Hastings23804832011-06-01 16:42:47 +0000245 if (Sub)
246 return
247 BinaryOperator::CreateMul(Sub,
248 ConstantInt::get(Y->getType(), PosVal));
Stuart Hastings82843742011-05-30 20:00:33 +0000249 }
250 }
251 }
Chris Lattner6b657ae2011-02-10 05:36:31 +0000252 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000253
Chris Lattner6b657ae2011-02-10 05:36:31 +0000254 // Simplify mul instructions with a constant RHS.
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000255 if (isa<Constant>(Op1)) {
Sanjay Pateldb0938f2017-01-10 23:49:07 +0000256 if (Instruction *FoldedMul = foldOpWithConstantIntoOperand(I))
257 return FoldedMul;
Benjamin Kramer72196f32014-01-19 15:24:22 +0000258
259 // Canonicalize (X+C1)*CI -> X*CI+C1*CI.
260 {
261 Value *X;
262 Constant *C1;
263 if (match(Op0, m_OneUse(m_Add(m_Value(X), m_Constant(C1))))) {
Craig Topperbb4069e2017-07-07 23:16:26 +0000264 Value *Mul = Builder.CreateMul(C1, Op1);
David Majnemer6cf6c052014-06-19 07:14:33 +0000265 // Only go forward with the transform if C1*CI simplifies to a tidier
266 // constant.
267 if (!match(Mul, m_Mul(m_Value(), m_Value())))
Craig Topperbb4069e2017-07-07 23:16:26 +0000268 return BinaryOperator::CreateAdd(Builder.CreateMul(X, Op1), Mul);
Benjamin Kramer72196f32014-01-19 15:24:22 +0000269 }
270 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000271 }
272
Sanjay Patel604cb9e2018-02-14 16:50:55 +0000273 // -X * C --> X * -C
274 Value *X, *Y;
275 Constant *Op1C;
276 if (match(Op0, m_Neg(m_Value(X))) && match(Op1, m_Constant(Op1C)))
277 return BinaryOperator::CreateMul(X, ConstantExpr::getNeg(Op1C));
278
279 // -X * -Y --> X * Y
280 if (match(Op0, m_Neg(m_Value(X))) && match(Op1, m_Neg(m_Value(Y)))) {
281 auto *NewMul = BinaryOperator::CreateMul(X, Y);
282 if (I.hasNoSignedWrap() &&
283 cast<OverflowingBinaryOperator>(Op0)->hasNoSignedWrap() &&
284 cast<OverflowingBinaryOperator>(Op1)->hasNoSignedWrap())
285 NewMul->setHasNoSignedWrap();
286 return NewMul;
David Majnemer8279a7502014-11-22 07:25:19 +0000287 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000288
289 // (X / Y) * Y = X - (X % Y)
290 // (X / Y) * -Y = (X % Y) - X
291 {
Sanjay Patela0a56822017-03-14 17:27:27 +0000292 Value *Y = Op1;
293 BinaryOperator *Div = dyn_cast<BinaryOperator>(Op0);
294 if (!Div || (Div->getOpcode() != Instruction::UDiv &&
295 Div->getOpcode() != Instruction::SDiv)) {
296 Y = Op0;
297 Div = dyn_cast<BinaryOperator>(Op1);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000298 }
Sanjay Patela0a56822017-03-14 17:27:27 +0000299 Value *Neg = dyn_castNegVal(Y);
300 if (Div && Div->hasOneUse() &&
301 (Div->getOperand(1) == Y || Div->getOperand(1) == Neg) &&
302 (Div->getOpcode() == Instruction::UDiv ||
303 Div->getOpcode() == Instruction::SDiv)) {
304 Value *X = Div->getOperand(0), *DivOp1 = Div->getOperand(1);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000305
Chris Lattner35315d02011-02-06 21:44:57 +0000306 // If the division is exact, X % Y is zero, so we end up with X or -X.
Sanjay Patela0a56822017-03-14 17:27:27 +0000307 if (Div->isExact()) {
308 if (DivOp1 == Y)
309 return replaceInstUsesWith(I, X);
310 return BinaryOperator::CreateNeg(X);
311 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000312
Sanjay Patela0a56822017-03-14 17:27:27 +0000313 auto RemOpc = Div->getOpcode() == Instruction::UDiv ? Instruction::URem
314 : Instruction::SRem;
Craig Topperbb4069e2017-07-07 23:16:26 +0000315 Value *Rem = Builder.CreateBinOp(RemOpc, X, DivOp1);
Sanjay Patela0a56822017-03-14 17:27:27 +0000316 if (DivOp1 == Y)
317 return BinaryOperator::CreateSub(X, Rem);
318 return BinaryOperator::CreateSub(Rem, X);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000319 }
320 }
321
322 /// i1 mul -> i1 and.
Craig Topperfde47232017-07-09 07:04:03 +0000323 if (I.getType()->isIntOrIntVectorTy(1))
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000324 return BinaryOperator::CreateAnd(Op0, Op1);
325
326 // X*(1 << Y) --> X << Y
327 // (1 << Y)*X --> X << Y
328 {
329 Value *Y;
David Majnemer546f8102014-11-22 08:57:02 +0000330 BinaryOperator *BO = nullptr;
331 bool ShlNSW = false;
332 if (match(Op0, m_Shl(m_One(), m_Value(Y)))) {
333 BO = BinaryOperator::CreateShl(Op1, Y);
David Majnemer087dc8b2015-01-04 07:36:02 +0000334 ShlNSW = cast<ShlOperator>(Op0)->hasNoSignedWrap();
David Majnemer8e6f6a92014-11-24 16:41:13 +0000335 } else if (match(Op1, m_Shl(m_One(), m_Value(Y)))) {
David Majnemer546f8102014-11-22 08:57:02 +0000336 BO = BinaryOperator::CreateShl(Op0, Y);
David Majnemer087dc8b2015-01-04 07:36:02 +0000337 ShlNSW = cast<ShlOperator>(Op1)->hasNoSignedWrap();
David Majnemer546f8102014-11-22 08:57:02 +0000338 }
339 if (BO) {
340 if (I.hasNoUnsignedWrap())
341 BO->setHasNoUnsignedWrap();
342 if (I.hasNoSignedWrap() && ShlNSW)
343 BO->setHasNoSignedWrap();
344 return BO;
345 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000346 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000347
Sanjay Patelcb8ac002018-02-13 20:41:22 +0000348 // (bool X) * Y --> X ? Y : 0
Sanjay Patel7558d862018-02-13 22:24:37 +0000349 // Y * (bool X) --> X ? Y : 0
Sanjay Patelcb8ac002018-02-13 20:41:22 +0000350 if (match(Op0, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
351 return SelectInst::Create(X, Op1, ConstantInt::get(I.getType(), 0));
Sanjay Patelcb8ac002018-02-13 20:41:22 +0000352 if (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
353 return SelectInst::Create(X, Op0, ConstantInt::get(I.getType(), 0));
354
Sanjay Patel7558d862018-02-13 22:24:37 +0000355 // (lshr X, 31) * Y --> (ashr X, 31) & Y
356 // Y * (lshr X, 31) --> (ashr X, 31) & Y
357 // TODO: We are not checking one-use because the elimination of the multiply
358 // is better for analysis?
359 // TODO: Should we canonicalize to '(X < 0) ? Y : 0' instead? That would be
360 // more similar to what we're doing above.
361 const APInt *C;
362 if (match(Op0, m_LShr(m_Value(X), m_APInt(C))) && *C == C->getBitWidth() - 1)
363 return BinaryOperator::CreateAnd(Builder.CreateAShr(X, *C), Op1);
364 if (match(Op1, m_LShr(m_Value(X), m_APInt(C))) && *C == C->getBitWidth() - 1)
365 return BinaryOperator::CreateAnd(Builder.CreateAShr(X, *C), Op0);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000366
David Majnemera1cfd7c2016-12-30 00:28:58 +0000367 // Check for (mul (sext x), y), see if we can merge this into an
368 // integer mul followed by a sext.
369 if (SExtInst *Op0Conv = dyn_cast<SExtInst>(Op0)) {
370 // (mul (sext x), cst) --> (sext (mul x, cst'))
371 if (ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
372 if (Op0Conv->hasOneUse()) {
373 Constant *CI =
374 ConstantExpr::getTrunc(Op1C, Op0Conv->getOperand(0)->getType());
375 if (ConstantExpr::getSExt(CI, I.getType()) == Op1C &&
Craig Topper2b1fc322017-05-22 06:25:31 +0000376 willNotOverflowSignedMul(Op0Conv->getOperand(0), CI, I)) {
David Majnemera1cfd7c2016-12-30 00:28:58 +0000377 // Insert the new, smaller mul.
378 Value *NewMul =
Craig Topperbb4069e2017-07-07 23:16:26 +0000379 Builder.CreateNSWMul(Op0Conv->getOperand(0), CI, "mulconv");
David Majnemera1cfd7c2016-12-30 00:28:58 +0000380 return new SExtInst(NewMul, I.getType());
381 }
382 }
383 }
384
385 // (mul (sext x), (sext y)) --> (sext (mul int x, y))
386 if (SExtInst *Op1Conv = dyn_cast<SExtInst>(Op1)) {
387 // Only do this if x/y have the same type, if at last one of them has a
388 // single use (so we don't increase the number of sexts), and if the
389 // integer mul will not overflow.
390 if (Op0Conv->getOperand(0)->getType() ==
391 Op1Conv->getOperand(0)->getType() &&
392 (Op0Conv->hasOneUse() || Op1Conv->hasOneUse()) &&
Craig Topper2b1fc322017-05-22 06:25:31 +0000393 willNotOverflowSignedMul(Op0Conv->getOperand(0),
David Majnemera1cfd7c2016-12-30 00:28:58 +0000394 Op1Conv->getOperand(0), I)) {
395 // Insert the new integer mul.
Craig Topperbb4069e2017-07-07 23:16:26 +0000396 Value *NewMul = Builder.CreateNSWMul(
David Majnemera1cfd7c2016-12-30 00:28:58 +0000397 Op0Conv->getOperand(0), Op1Conv->getOperand(0), "mulconv");
398 return new SExtInst(NewMul, I.getType());
399 }
400 }
401 }
402
403 // Check for (mul (zext x), y), see if we can merge this into an
404 // integer mul followed by a zext.
405 if (auto *Op0Conv = dyn_cast<ZExtInst>(Op0)) {
406 // (mul (zext x), cst) --> (zext (mul x, cst'))
407 if (ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
408 if (Op0Conv->hasOneUse()) {
409 Constant *CI =
410 ConstantExpr::getTrunc(Op1C, Op0Conv->getOperand(0)->getType());
411 if (ConstantExpr::getZExt(CI, I.getType()) == Op1C &&
Craig Topperbb973722017-05-15 02:44:08 +0000412 willNotOverflowUnsignedMul(Op0Conv->getOperand(0), CI, I)) {
David Majnemera1cfd7c2016-12-30 00:28:58 +0000413 // Insert the new, smaller mul.
414 Value *NewMul =
Craig Topperbb4069e2017-07-07 23:16:26 +0000415 Builder.CreateNUWMul(Op0Conv->getOperand(0), CI, "mulconv");
David Majnemera1cfd7c2016-12-30 00:28:58 +0000416 return new ZExtInst(NewMul, I.getType());
417 }
418 }
419 }
420
421 // (mul (zext x), (zext y)) --> (zext (mul int x, y))
422 if (auto *Op1Conv = dyn_cast<ZExtInst>(Op1)) {
423 // Only do this if x/y have the same type, if at last one of them has a
424 // single use (so we don't increase the number of zexts), and if the
425 // integer mul will not overflow.
426 if (Op0Conv->getOperand(0)->getType() ==
427 Op1Conv->getOperand(0)->getType() &&
428 (Op0Conv->hasOneUse() || Op1Conv->hasOneUse()) &&
Craig Topperbb973722017-05-15 02:44:08 +0000429 willNotOverflowUnsignedMul(Op0Conv->getOperand(0),
430 Op1Conv->getOperand(0), I)) {
David Majnemera1cfd7c2016-12-30 00:28:58 +0000431 // Insert the new integer mul.
Craig Topperbb4069e2017-07-07 23:16:26 +0000432 Value *NewMul = Builder.CreateNUWMul(
David Majnemera1cfd7c2016-12-30 00:28:58 +0000433 Op0Conv->getOperand(0), Op1Conv->getOperand(0), "mulconv");
434 return new ZExtInst(NewMul, I.getType());
435 }
436 }
437 }
438
Craig Topper2b1fc322017-05-22 06:25:31 +0000439 if (!I.hasNoSignedWrap() && willNotOverflowSignedMul(Op0, Op1, I)) {
David Majnemer54c2ca22014-12-26 09:10:14 +0000440 Changed = true;
441 I.setHasNoSignedWrap(true);
442 }
443
Craig Topperbb973722017-05-15 02:44:08 +0000444 if (!I.hasNoUnsignedWrap() && willNotOverflowUnsignedMul(Op0, Op1, I)) {
David Majnemerb1296ec2014-12-26 09:50:35 +0000445 Changed = true;
446 I.setHasNoUnsignedWrap(true);
447 }
448
Craig Topperf40110f2014-04-25 05:29:35 +0000449 return Changed ? &I : nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000450}
451
Sanjay Patel17045f72014-10-14 00:33:23 +0000452/// Detect pattern log2(Y * 0.5) with corresponding fast math flags.
Pedro Artigas993acd02012-11-30 22:07:05 +0000453static void detectLog2OfHalf(Value *&Op, Value *&Y, IntrinsicInst *&Log2) {
Sanjay Patel17045f72014-10-14 00:33:23 +0000454 if (!Op->hasOneUse())
455 return;
Pedro Artigas00b83c92012-11-30 22:47:15 +0000456
Sanjay Patel17045f72014-10-14 00:33:23 +0000457 IntrinsicInst *II = dyn_cast<IntrinsicInst>(Op);
458 if (!II)
459 return;
Sanjay Patel629c4112017-11-06 16:27:15 +0000460 if (II->getIntrinsicID() != Intrinsic::log2 || !II->isFast())
Sanjay Patel17045f72014-10-14 00:33:23 +0000461 return;
462 Log2 = II;
Pedro Artigas00b83c92012-11-30 22:47:15 +0000463
Sanjay Patel17045f72014-10-14 00:33:23 +0000464 Value *OpLog2Of = II->getArgOperand(0);
465 if (!OpLog2Of->hasOneUse())
466 return;
Pedro Artigas00b83c92012-11-30 22:47:15 +0000467
Sanjay Patel17045f72014-10-14 00:33:23 +0000468 Instruction *I = dyn_cast<Instruction>(OpLog2Of);
469 if (!I)
470 return;
Sanjay Patel629c4112017-11-06 16:27:15 +0000471
472 if (I->getOpcode() != Instruction::FMul || !I->isFast())
Sanjay Patel17045f72014-10-14 00:33:23 +0000473 return;
Pedro Artigas00b83c92012-11-30 22:47:15 +0000474
Sanjay Patel17045f72014-10-14 00:33:23 +0000475 if (match(I->getOperand(0), m_SpecificFP(0.5)))
476 Y = I->getOperand(1);
477 else if (match(I->getOperand(1), m_SpecificFP(0.5)))
478 Y = I->getOperand(0);
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000479}
Pedro Artigas993acd02012-11-30 22:07:05 +0000480
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000481static bool isFiniteNonZeroFp(Constant *C) {
482 if (C->getType()->isVectorTy()) {
483 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E;
484 ++I) {
Michael Kupersteinbcb26d62015-03-05 08:38:57 +0000485 ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(C->getAggregateElement(I));
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000486 if (!CFP || !CFP->getValueAPF().isFiniteNonZero())
487 return false;
488 }
489 return true;
490 }
491
492 return isa<ConstantFP>(C) &&
493 cast<ConstantFP>(C)->getValueAPF().isFiniteNonZero();
494}
495
496static bool isNormalFp(Constant *C) {
497 if (C->getType()->isVectorTy()) {
498 for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E;
499 ++I) {
Michael Kupersteinbcb26d62015-03-05 08:38:57 +0000500 ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(C->getAggregateElement(I));
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000501 if (!CFP || !CFP->getValueAPF().isNormal())
502 return false;
503 }
504 return true;
505 }
506
507 return isa<ConstantFP>(C) && cast<ConstantFP>(C)->getValueAPF().isNormal();
508}
509
Sanjay Patel5df4d882018-02-14 17:16:33 +0000510/// Helper function of InstCombiner::visitFMul(). Return true iff the given
511/// value is FMul or FDiv with one and only one operand being a finite-non-zero
512/// constant (i.e. not Zero/NaN/Infinity).
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000513static bool isFMulOrFDivWithConstant(Value *V) {
Sanjay Patel5df4d882018-02-14 17:16:33 +0000514 Constant *C;
515 return (match(V, m_FMul(m_Value(), m_Constant(C))) ||
516 match(V, m_FDiv(m_Value(), m_Constant(C))) ||
517 match(V, m_FDiv(m_Constant(C), m_Value()))) && isFiniteNonZeroFp(C);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000518}
519
520/// foldFMulConst() is a helper routine of InstCombiner::visitFMul().
521/// The input \p FMulOrDiv is a FMul/FDiv with one and only one operand
522/// being a constant (i.e. isFMulOrFDivWithConstant(FMulOrDiv) == true).
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000523/// This function is to simplify "FMulOrDiv * C" and returns the
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000524/// resulting expression. Note that this function could return NULL in
525/// case the constants cannot be folded into a normal floating-point.
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000526Value *InstCombiner::foldFMulConst(Instruction *FMulOrDiv, Constant *C,
Shuxin Yang80138662013-01-07 22:41:28 +0000527 Instruction *InsertBefore) {
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000528 assert(isFMulOrFDivWithConstant(FMulOrDiv) && "V is invalid");
529
530 Value *Opnd0 = FMulOrDiv->getOperand(0);
531 Value *Opnd1 = FMulOrDiv->getOperand(1);
532
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000533 Constant *C0 = dyn_cast<Constant>(Opnd0);
534 Constant *C1 = dyn_cast<Constant>(Opnd1);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000535
Craig Topperf40110f2014-04-25 05:29:35 +0000536 BinaryOperator *R = nullptr;
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000537
538 // (X * C0) * C => X * (C0*C)
539 if (FMulOrDiv->getOpcode() == Instruction::FMul) {
540 Constant *F = ConstantExpr::getFMul(C1 ? C1 : C0, C);
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000541 if (isNormalFp(F))
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000542 R = BinaryOperator::CreateFMul(C1 ? Opnd0 : Opnd1, F);
543 } else {
544 if (C0) {
545 // (C0 / X) * C => (C0 * C) / X
Shuxin Yang3a7ca6e2013-09-19 21:13:46 +0000546 if (FMulOrDiv->hasOneUse()) {
547 // It would otherwise introduce another div.
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000548 Constant *F = ConstantExpr::getFMul(C0, C);
Shuxin Yang3a7ca6e2013-09-19 21:13:46 +0000549 if (isNormalFp(F))
550 R = BinaryOperator::CreateFDiv(F, Opnd1);
551 }
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000552 } else {
553 // (X / C1) * C => X * (C/C1) if C/C1 is not a denormal
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000554 Constant *F = ConstantExpr::getFDiv(C, C1);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000555 if (isNormalFp(F)) {
556 R = BinaryOperator::CreateFMul(Opnd0, F);
557 } else {
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000558 // (X / C1) * C => X / (C1/C)
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000559 Constant *F = ConstantExpr::getFDiv(C1, C);
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000560 if (isNormalFp(F))
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000561 R = BinaryOperator::CreateFDiv(Opnd0, F);
562 }
563 }
564 }
565
566 if (R) {
Sanjay Patel629c4112017-11-06 16:27:15 +0000567 R->setFast(true);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000568 InsertNewInstWith(R, *InsertBefore);
569 }
570
571 return R;
572}
573
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000574Instruction *InstCombiner::visitFMul(BinaryOperator &I) {
Duncan Sands641baf12010-11-13 15:10:37 +0000575 bool Changed = SimplifyAssociativeOrCommutative(I);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000576 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
577
Serge Pavlov9ef66a82014-05-11 08:46:12 +0000578 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +0000579 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +0000580
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000581 if (isa<Constant>(Op0))
582 std::swap(Op0, Op1);
583
Craig Toppera4205622017-06-09 03:21:29 +0000584 if (Value *V = SimplifyFMulInst(Op0, Op1, I.getFastMathFlags(),
585 SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +0000586 return replaceInstUsesWith(I, V);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000587
Sanjay Patel629c4112017-11-06 16:27:15 +0000588 bool AllowReassociate = I.isFast();
Shuxin Yange8227452013-01-15 21:09:32 +0000589
Michael Ilsemand5787be2012-12-12 00:28:32 +0000590 // Simplify mul instructions with a constant RHS.
Sanjay Patel58dab852018-02-14 16:56:44 +0000591 if (auto *C = dyn_cast<Constant>(Op1)) {
Sanjay Pateldb0938f2017-01-10 23:49:07 +0000592 if (Instruction *FoldedMul = foldOpWithConstantIntoOperand(I))
593 return FoldedMul;
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000594
Owen Andersonf74cfe02014-01-16 20:36:42 +0000595 // (fmul X, -1.0) --> (fsub -0.0, X)
Sanjay Patel58dab852018-02-14 16:56:44 +0000596 if (match(C, m_SpecificFP(-1.0))) {
Benjamin Kramerfea9ac92014-01-18 16:43:14 +0000597 Constant *NegZero = ConstantFP::getNegativeZero(Op1->getType());
598 Instruction *RI = BinaryOperator::CreateFSub(NegZero, Op0);
Owen Andersonf74cfe02014-01-16 20:36:42 +0000599 RI->copyFastMathFlags(&I);
600 return RI;
601 }
602
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000603 if (AllowReassociate && isFiniteNonZeroFp(C)) {
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000604 // Let MDC denote an expression in one of these forms:
605 // X * C, C/X, X/C, where C is a constant.
606 //
607 // Try to simplify "MDC * Constant"
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000608 if (isFMulOrFDivWithConstant(Op0))
609 if (Value *V = foldFMulConst(cast<Instruction>(Op0), C, &I))
Sanjay Patel4b198802016-02-01 22:23:39 +0000610 return replaceInstUsesWith(I, V);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000611
Quentin Colombete684a6d2013-02-28 21:12:40 +0000612 // (MDC +/- C1) * C => (MDC * C) +/- (C1 * C)
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000613 Instruction *FAddSub = dyn_cast<Instruction>(Op0);
614 if (FAddSub &&
615 (FAddSub->getOpcode() == Instruction::FAdd ||
616 FAddSub->getOpcode() == Instruction::FSub)) {
617 Value *Opnd0 = FAddSub->getOperand(0);
618 Value *Opnd1 = FAddSub->getOperand(1);
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000619 Constant *C0 = dyn_cast<Constant>(Opnd0);
620 Constant *C1 = dyn_cast<Constant>(Opnd1);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000621 bool Swap = false;
622 if (C0) {
Shuxin Yang80138662013-01-07 22:41:28 +0000623 std::swap(C0, C1);
624 std::swap(Opnd0, Opnd1);
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000625 Swap = true;
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000626 }
627
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000628 if (C1 && isFiniteNonZeroFp(C1) && isFMulOrFDivWithConstant(Opnd0)) {
Quentin Colombete684a6d2013-02-28 21:12:40 +0000629 Value *M1 = ConstantExpr::getFMul(C1, C);
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000630 Value *M0 = isNormalFp(cast<Constant>(M1)) ?
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000631 foldFMulConst(cast<Instruction>(Opnd0), C, &I) :
Craig Topperf40110f2014-04-25 05:29:35 +0000632 nullptr;
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000633 if (M0 && M1) {
634 if (Swap && FAddSub->getOpcode() == Instruction::FSub)
635 std::swap(M0, M1);
636
Benjamin Kramer67485762013-09-30 15:39:59 +0000637 Instruction *RI = (FAddSub->getOpcode() == Instruction::FAdd)
638 ? BinaryOperator::CreateFAdd(M0, M1)
639 : BinaryOperator::CreateFSub(M0, M1);
Shuxin Yange8227452013-01-15 21:09:32 +0000640 RI->copyFastMathFlags(&I);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000641 return RI;
642 }
643 }
644 }
645 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000646 }
647
Matt Arsenault56c079f2016-01-30 05:02:00 +0000648 if (Op0 == Op1) {
649 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Op0)) {
650 // sqrt(X) * sqrt(X) -> X
651 if (AllowReassociate && II->getIntrinsicID() == Intrinsic::sqrt)
Sanjay Patel4b198802016-02-01 22:23:39 +0000652 return replaceInstUsesWith(I, II->getOperand(0));
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000653
Matt Arsenault56c079f2016-01-30 05:02:00 +0000654 // fabs(X) * fabs(X) -> X * X
655 if (II->getIntrinsicID() == Intrinsic::fabs) {
656 Instruction *FMulVal = BinaryOperator::CreateFMul(II->getOperand(0),
657 II->getOperand(0),
658 I.getName());
659 FMulVal->copyFastMathFlags(&I);
660 return FMulVal;
661 }
662 }
663 }
664
Pedro Artigasd8795042012-11-30 19:09:41 +0000665 // Under unsafe algebra do:
666 // X * log2(0.5*Y) = X*log2(Y) - X
Sanjay Patelb41d4612014-10-02 15:20:45 +0000667 if (AllowReassociate) {
Craig Topperf40110f2014-04-25 05:29:35 +0000668 Value *OpX = nullptr;
669 Value *OpY = nullptr;
Pedro Artigasd8795042012-11-30 19:09:41 +0000670 IntrinsicInst *Log2;
Pedro Artigas993acd02012-11-30 22:07:05 +0000671 detectLog2OfHalf(Op0, OpY, Log2);
672 if (OpY) {
673 OpX = Op1;
674 } else {
675 detectLog2OfHalf(Op1, OpY, Log2);
676 if (OpY) {
677 OpX = Op0;
Pedro Artigasd8795042012-11-30 19:09:41 +0000678 }
679 }
680 // if pattern detected emit alternate sequence
681 if (OpX && OpY) {
Craig Topperbb4069e2017-07-07 23:16:26 +0000682 BuilderTy::FastMathFlagGuard Guard(Builder);
683 Builder.setFastMathFlags(Log2->getFastMathFlags());
Pedro Artigasd8795042012-11-30 19:09:41 +0000684 Log2->setArgOperand(0, OpY);
Craig Topperbb4069e2017-07-07 23:16:26 +0000685 Value *FMulVal = Builder.CreateFMul(OpX, Log2);
686 Value *FSub = Builder.CreateFSub(FMulVal, OpX);
Benjamin Kramer67485762013-09-30 15:39:59 +0000687 FSub->takeName(&I);
Sanjay Patel4b198802016-02-01 22:23:39 +0000688 return replaceInstUsesWith(I, FSub);
Pedro Artigasd8795042012-11-30 19:09:41 +0000689 }
690 }
691
Dmitry Venikova58d8de2018-01-02 05:58:11 +0000692 // sqrt(a) * sqrt(b) -> sqrt(a * b)
Sanjay Patel1998cc62018-02-12 18:38:35 +0000693 if (AllowReassociate && Op0->hasOneUse() && Op1->hasOneUse()) {
Dmitry Venikova58d8de2018-01-02 05:58:11 +0000694 Value *Opnd0 = nullptr;
695 Value *Opnd1 = nullptr;
696 if (match(Op0, m_Intrinsic<Intrinsic::sqrt>(m_Value(Opnd0))) &&
697 match(Op1, m_Intrinsic<Intrinsic::sqrt>(m_Value(Opnd1)))) {
698 BuilderTy::FastMathFlagGuard Guard(Builder);
699 Builder.setFastMathFlags(I.getFastMathFlags());
700 Value *FMulVal = Builder.CreateFMul(Opnd0, Opnd1);
701 Value *Sqrt = Intrinsic::getDeclaration(I.getModule(),
702 Intrinsic::sqrt, I.getType());
703 Value *SqrtCall = Builder.CreateCall(Sqrt, FMulVal);
704 return replaceInstUsesWith(I, SqrtCall);
705 }
706 }
707
Shuxin Yange8227452013-01-15 21:09:32 +0000708 // Handle symmetric situation in a 2-iteration loop
709 Value *Opnd0 = Op0;
710 Value *Opnd1 = Op1;
711 for (int i = 0; i < 2; i++) {
712 bool IgnoreZeroSign = I.hasNoSignedZeros();
713 if (BinaryOperator::isFNeg(Opnd0, IgnoreZeroSign)) {
Craig Topperbb4069e2017-07-07 23:16:26 +0000714 BuilderTy::FastMathFlagGuard Guard(Builder);
715 Builder.setFastMathFlags(I.getFastMathFlags());
Benjamin Kramer67485762013-09-30 15:39:59 +0000716
Shuxin Yange8227452013-01-15 21:09:32 +0000717 Value *N0 = dyn_castFNegVal(Opnd0, IgnoreZeroSign);
718 Value *N1 = dyn_castFNegVal(Opnd1, IgnoreZeroSign);
Shuxin Yangf8e9a5a2012-12-14 18:46:06 +0000719
Shuxin Yange8227452013-01-15 21:09:32 +0000720 // -X * -Y => X*Y
Owen Andersone8537fc2014-01-16 20:59:41 +0000721 if (N1) {
Craig Topperbb4069e2017-07-07 23:16:26 +0000722 Value *FMul = Builder.CreateFMul(N0, N1);
Owen Andersone8537fc2014-01-16 20:59:41 +0000723 FMul->takeName(&I);
Sanjay Patel4b198802016-02-01 22:23:39 +0000724 return replaceInstUsesWith(I, FMul);
Owen Andersone8537fc2014-01-16 20:59:41 +0000725 }
Shuxin Yangf8e9a5a2012-12-14 18:46:06 +0000726
Shuxin Yange8227452013-01-15 21:09:32 +0000727 if (Opnd0->hasOneUse()) {
728 // -X * Y => -(X*Y) (Promote negation as high as possible)
Craig Topperbb4069e2017-07-07 23:16:26 +0000729 Value *T = Builder.CreateFMul(N0, Opnd1);
730 Value *Neg = Builder.CreateFNeg(T);
Benjamin Kramer67485762013-09-30 15:39:59 +0000731 Neg->takeName(&I);
Sanjay Patel4b198802016-02-01 22:23:39 +0000732 return replaceInstUsesWith(I, Neg);
Shuxin Yangf8e9a5a2012-12-14 18:46:06 +0000733 }
734 }
Shuxin Yange8227452013-01-15 21:09:32 +0000735
Quentin Colombetaa103b32017-09-20 17:32:16 +0000736 // Handle specials cases for FMul with selects feeding the operation
737 if (Value *V = SimplifySelectsFeedingBinaryOp(I, Op0, Op1))
738 return replaceInstUsesWith(I, V);
739
Shuxin Yange8227452013-01-15 21:09:32 +0000740 // (X*Y) * X => (X*X) * Y where Y != X
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000741 // The purpose is two-fold:
Shuxin Yange8227452013-01-15 21:09:32 +0000742 // 1) to form a power expression (of X).
743 // 2) potentially shorten the critical path: After transformation, the
744 // latency of the instruction Y is amortized by the expression of X*X,
745 // and therefore Y is in a "less critical" position compared to what it
746 // was before the transformation.
Shuxin Yange8227452013-01-15 21:09:32 +0000747 if (AllowReassociate) {
748 Value *Opnd0_0, *Opnd0_1;
749 if (Opnd0->hasOneUse() &&
750 match(Opnd0, m_FMul(m_Value(Opnd0_0), m_Value(Opnd0_1)))) {
Craig Topperf40110f2014-04-25 05:29:35 +0000751 Value *Y = nullptr;
Shuxin Yange8227452013-01-15 21:09:32 +0000752 if (Opnd0_0 == Opnd1 && Opnd0_1 != Opnd1)
753 Y = Opnd0_1;
754 else if (Opnd0_1 == Opnd1 && Opnd0_0 != Opnd1)
755 Y = Opnd0_0;
756
757 if (Y) {
Craig Topperbb4069e2017-07-07 23:16:26 +0000758 BuilderTy::FastMathFlagGuard Guard(Builder);
759 Builder.setFastMathFlags(I.getFastMathFlags());
760 Value *T = Builder.CreateFMul(Opnd1, Opnd1);
761 Value *R = Builder.CreateFMul(T, Y);
Benjamin Kramer67485762013-09-30 15:39:59 +0000762 R->takeName(&I);
Sanjay Patel4b198802016-02-01 22:23:39 +0000763 return replaceInstUsesWith(I, R);
Shuxin Yange8227452013-01-15 21:09:32 +0000764 }
765 }
766 }
767
768 if (!isa<Constant>(Op1))
769 std::swap(Opnd0, Opnd1);
770 else
771 break;
Shuxin Yangf8e9a5a2012-12-14 18:46:06 +0000772 }
773
Craig Topperf40110f2014-04-25 05:29:35 +0000774 return Changed ? &I : nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000775}
776
Sanjay Patelae2e3a42017-10-06 23:20:16 +0000777/// Fold a divide or remainder with a select instruction divisor when one of the
778/// select operands is zero. In that case, we can use the other select operand
779/// because div/rem by zero is undefined.
780bool InstCombiner::simplifyDivRemOfSelectWithZeroOp(BinaryOperator &I) {
781 SelectInst *SI = dyn_cast<SelectInst>(I.getOperand(1));
782 if (!SI)
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000783 return false;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000784
Sanjay Patelae2e3a42017-10-06 23:20:16 +0000785 int NonNullOperand;
786 if (match(SI->getTrueValue(), m_Zero()))
787 // div/rem X, (Cond ? 0 : Y) -> div/rem X, Y
788 NonNullOperand = 2;
789 else if (match(SI->getFalseValue(), m_Zero()))
790 // div/rem X, (Cond ? Y : 0) -> div/rem X, Y
791 NonNullOperand = 1;
792 else
793 return false;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000794
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000795 // Change the div/rem to use 'Y' instead of the select.
796 I.setOperand(1, SI->getOperand(NonNullOperand));
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000797
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000798 // Okay, we know we replace the operand of the div/rem with 'Y' with no
799 // problem. However, the select, or the condition of the select may have
800 // multiple uses. Based on our knowledge that the operand must be non-zero,
801 // propagate the known value for the select into other uses of it, and
802 // propagate a known value of the condition into its other users.
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000803
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000804 // If the select and condition only have a single use, don't bother with this,
805 // early exit.
Sanjay Patelae2e3a42017-10-06 23:20:16 +0000806 Value *SelectCond = SI->getCondition();
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000807 if (SI->use_empty() && SelectCond->hasOneUse())
808 return true;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000809
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000810 // Scan the current block backward, looking for other uses of SI.
Duncan P. N. Exon Smith9f8aaf22015-10-13 16:59:33 +0000811 BasicBlock::iterator BBI = I.getIterator(), BBFront = I.getParent()->begin();
Sanjay Patel72d339a2017-10-06 23:43:06 +0000812 Type *CondTy = SelectCond->getType();
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000813 while (BBI != BBFront) {
814 --BBI;
815 // If we found a call to a function, we can't assume it will return, so
816 // information from below it cannot be propagated above it.
817 if (isa<CallInst>(BBI) && !isa<IntrinsicInst>(BBI))
818 break;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000819
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000820 // Replace uses of the select or its condition with the known values.
821 for (Instruction::op_iterator I = BBI->op_begin(), E = BBI->op_end();
822 I != E; ++I) {
823 if (*I == SI) {
824 *I = SI->getOperand(NonNullOperand);
Duncan P. N. Exon Smith9f8aaf22015-10-13 16:59:33 +0000825 Worklist.Add(&*BBI);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000826 } else if (*I == SelectCond) {
Sanjay Patel72d339a2017-10-06 23:43:06 +0000827 *I = NonNullOperand == 1 ? ConstantInt::getTrue(CondTy)
828 : ConstantInt::getFalse(CondTy);
Duncan P. N. Exon Smith9f8aaf22015-10-13 16:59:33 +0000829 Worklist.Add(&*BBI);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000830 }
831 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000832
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000833 // If we past the instruction, quit looking for it.
834 if (&*BBI == SI)
Craig Topperf40110f2014-04-25 05:29:35 +0000835 SI = nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000836 if (&*BBI == SelectCond)
Craig Topperf40110f2014-04-25 05:29:35 +0000837 SelectCond = nullptr;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000838
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000839 // If we ran out of things to eliminate, break out of the loop.
Craig Topperf40110f2014-04-25 05:29:35 +0000840 if (!SelectCond && !SI)
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000841 break;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000842
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000843 }
844 return true;
845}
846
Sanjay Patel1998cc62018-02-12 18:38:35 +0000847/// True if the multiply can not be expressed in an int this size.
848static bool multiplyOverflows(const APInt &C1, const APInt &C2, APInt &Product,
849 bool IsSigned) {
850 bool Overflow;
851 Product = IsSigned ? C1.smul_ov(C2, Overflow) : C1.umul_ov(C2, Overflow);
852 return Overflow;
853}
854
855/// True if C2 is a multiple of C1. Quotient contains C2/C1.
856static bool isMultiple(const APInt &C1, const APInt &C2, APInt &Quotient,
857 bool IsSigned) {
858 assert(C1.getBitWidth() == C2.getBitWidth() && "Constant widths not equal");
859
860 // Bail if we will divide by zero.
861 if (C2.isNullValue())
862 return false;
863
864 // Bail if we would divide INT_MIN by -1.
865 if (IsSigned && C1.isMinSignedValue() && C2.isAllOnesValue())
866 return false;
867
868 APInt Remainder(C1.getBitWidth(), /*Val=*/0ULL, IsSigned);
869 if (IsSigned)
870 APInt::sdivrem(C1, C2, Quotient, Remainder);
871 else
872 APInt::udivrem(C1, C2, Quotient, Remainder);
873
874 return Remainder.isMinValue();
875}
876
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000877/// This function implements the transforms common to both integer division
878/// instructions (udiv and sdiv). It is called by the visitors to those integer
879/// division instructions.
880/// @brief Common integer divide transforms
881Instruction *InstCombiner::commonIDivTransforms(BinaryOperator &I) {
882 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Sanjay Patel9530f182018-01-21 16:14:51 +0000883 bool IsSigned = I.getOpcode() == Instruction::SDiv;
Sanjay Patel39059d22018-02-12 14:14:56 +0000884 Type *Ty = I.getType();
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000885
Chris Lattner7c99f192011-05-22 18:18:41 +0000886 // The RHS is known non-zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000887 if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I)) {
Chris Lattner7c99f192011-05-22 18:18:41 +0000888 I.setOperand(1, V);
889 return &I;
890 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000891
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000892 // Handle cases involving: [su]div X, (select Cond, Y, Z)
893 // This does not apply for fdiv.
Sanjay Patelae2e3a42017-10-06 23:20:16 +0000894 if (simplifyDivRemOfSelectWithZeroOp(I))
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000895 return &I;
896
Sanjay Patel1998cc62018-02-12 18:38:35 +0000897 const APInt *C2;
898 if (match(Op1, m_APInt(C2))) {
899 Value *X;
900 const APInt *C1;
David Majnemerf9a095d2014-08-16 08:55:06 +0000901
Sanjay Patel1998cc62018-02-12 18:38:35 +0000902 // (X / C1) / C2 -> X / (C1*C2)
903 if ((IsSigned && match(Op0, m_SDiv(m_Value(X), m_APInt(C1)))) ||
904 (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_APInt(C1))))) {
905 APInt Product(C1->getBitWidth(), /*Val=*/0ULL, IsSigned);
906 if (!multiplyOverflows(*C1, *C2, Product, IsSigned))
907 return BinaryOperator::Create(I.getOpcode(), X,
908 ConstantInt::get(Ty, Product));
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000909 }
Sanjay Patel1998cc62018-02-12 18:38:35 +0000910
911 if ((IsSigned && match(Op0, m_NSWMul(m_Value(X), m_APInt(C1)))) ||
912 (!IsSigned && match(Op0, m_NUWMul(m_Value(X), m_APInt(C1))))) {
913 APInt Quotient(C1->getBitWidth(), /*Val=*/0ULL, IsSigned);
914
915 // (X * C1) / C2 -> X / (C2 / C1) if C2 is a multiple of C1.
916 if (isMultiple(*C2, *C1, Quotient, IsSigned)) {
917 auto *NewDiv = BinaryOperator::Create(I.getOpcode(), X,
918 ConstantInt::get(Ty, Quotient));
919 NewDiv->setIsExact(I.isExact());
920 return NewDiv;
921 }
922
923 // (X * C1) / C2 -> X * (C1 / C2) if C1 is a multiple of C2.
924 if (isMultiple(*C1, *C2, Quotient, IsSigned)) {
925 auto *Mul = BinaryOperator::Create(Instruction::Mul, X,
926 ConstantInt::get(Ty, Quotient));
927 auto *OBO = cast<OverflowingBinaryOperator>(Op0);
928 Mul->setHasNoUnsignedWrap(!IsSigned && OBO->hasNoUnsignedWrap());
929 Mul->setHasNoSignedWrap(OBO->hasNoSignedWrap());
930 return Mul;
931 }
932 }
933
934 if ((IsSigned && match(Op0, m_NSWShl(m_Value(X), m_APInt(C1))) &&
935 *C1 != C1->getBitWidth() - 1) ||
936 (!IsSigned && match(Op0, m_NUWShl(m_Value(X), m_APInt(C1))))) {
937 APInt Quotient(C1->getBitWidth(), /*Val=*/0ULL, IsSigned);
938 APInt C1Shifted = APInt::getOneBitSet(
939 C1->getBitWidth(), static_cast<unsigned>(C1->getLimitedValue()));
940
941 // (X << C1) / C2 -> X / (C2 >> C1) if C2 is a multiple of C1.
942 if (isMultiple(*C2, C1Shifted, Quotient, IsSigned)) {
943 auto *BO = BinaryOperator::Create(I.getOpcode(), X,
944 ConstantInt::get(Ty, Quotient));
945 BO->setIsExact(I.isExact());
946 return BO;
947 }
948
949 // (X << C1) / C2 -> X * (C2 >> C1) if C1 is a multiple of C2.
950 if (isMultiple(C1Shifted, *C2, Quotient, IsSigned)) {
951 auto *Mul = BinaryOperator::Create(Instruction::Mul, X,
952 ConstantInt::get(Ty, Quotient));
953 auto *OBO = cast<OverflowingBinaryOperator>(Op0);
954 Mul->setHasNoUnsignedWrap(!IsSigned && OBO->hasNoUnsignedWrap());
955 Mul->setHasNoSignedWrap(OBO->hasNoSignedWrap());
956 return Mul;
957 }
958 }
959
960 if (!C2->isNullValue()) // avoid X udiv 0
961 if (Instruction *FoldedDiv = foldOpWithConstantIntoOperand(I))
962 return FoldedDiv;
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000963 }
964
Craig Topper218a3592017-04-17 03:41:47 +0000965 if (match(Op0, m_One())) {
Sanjay Patel39059d22018-02-12 14:14:56 +0000966 assert(!Ty->isIntOrIntVectorTy(1) && "i1 divide not removed?");
967 if (IsSigned) {
Craig Topper218a3592017-04-17 03:41:47 +0000968 // If Op1 is 0 then it's undefined behaviour, if Op1 is 1 then the
969 // result is one, if Op1 is -1 then the result is minus one, otherwise
970 // it's zero.
Craig Topperbb4069e2017-07-07 23:16:26 +0000971 Value *Inc = Builder.CreateAdd(Op1, Op0);
Sanjay Patel39059d22018-02-12 14:14:56 +0000972 Value *Cmp = Builder.CreateICmpULT(Inc, ConstantInt::get(Ty, 3));
973 return SelectInst::Create(Cmp, Op1, ConstantInt::get(Ty, 0));
Craig Topper218a3592017-04-17 03:41:47 +0000974 } else {
975 // If Op1 is 0 then it's undefined behaviour. If Op1 is 1 then the
976 // result is one, otherwise it's zero.
Sanjay Patel39059d22018-02-12 14:14:56 +0000977 return new ZExtInst(Builder.CreateICmpEQ(Op1, Op0), Ty);
Nick Lewyckyf0cf8fa2014-05-14 03:03:05 +0000978 }
979 }
980
Benjamin Kramer57b3df52011-04-30 18:16:00 +0000981 // See if we can fold away this div instruction.
982 if (SimplifyDemandedInstructionBits(I))
983 return &I;
984
Duncan Sands771e82a2011-01-28 16:51:11 +0000985 // (X - (X rem Y)) / Y -> X / Y; usually originates as ((X / Y) * Y) / Y
Sanjay Patel9530f182018-01-21 16:14:51 +0000986 Value *X, *Z;
987 if (match(Op0, m_Sub(m_Value(X), m_Value(Z)))) // (X - Z) / Y; Y = Op1
988 if ((IsSigned && match(Z, m_SRem(m_Specific(X), m_Specific(Op1)))) ||
989 (!IsSigned && match(Z, m_URem(m_Specific(X), m_Specific(Op1)))))
Duncan Sands771e82a2011-01-28 16:51:11 +0000990 return BinaryOperator::Create(I.getOpcode(), X, Op1);
Sanjay Patel9530f182018-01-21 16:14:51 +0000991
992 // (X << Y) / X -> 1 << Y
993 Value *Y;
994 if (IsSigned && match(Op0, m_NSWShl(m_Specific(Op1), m_Value(Y))))
Sanjay Patel39059d22018-02-12 14:14:56 +0000995 return BinaryOperator::CreateNSWShl(ConstantInt::get(Ty, 1), Y);
Sanjay Patel9530f182018-01-21 16:14:51 +0000996 if (!IsSigned && match(Op0, m_NUWShl(m_Specific(Op1), m_Value(Y))))
Sanjay Patel39059d22018-02-12 14:14:56 +0000997 return BinaryOperator::CreateNUWShl(ConstantInt::get(Ty, 1), Y);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000998
Sanjay Patel510d6472018-02-11 17:20:32 +0000999 // X / (X * Y) -> 1 / Y if the multiplication does not overflow.
1000 if (match(Op1, m_c_Mul(m_Specific(Op0), m_Value(Y)))) {
1001 bool HasNSW = cast<OverflowingBinaryOperator>(Op1)->hasNoSignedWrap();
1002 bool HasNUW = cast<OverflowingBinaryOperator>(Op1)->hasNoUnsignedWrap();
1003 if ((IsSigned && HasNSW) || (!IsSigned && HasNUW)) {
Sanjay Patel39059d22018-02-12 14:14:56 +00001004 I.setOperand(0, ConstantInt::get(Ty, 1));
Sanjay Patel510d6472018-02-11 17:20:32 +00001005 I.setOperand(1, Y);
1006 return &I;
1007 }
1008 }
1009
Craig Topperf40110f2014-04-25 05:29:35 +00001010 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001011}
1012
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +00001013static const unsigned MaxDepth = 6;
1014
David Majnemer37f8f442013-07-04 21:17:49 +00001015namespace {
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +00001016
1017using FoldUDivOperandCb = Instruction *(*)(Value *Op0, Value *Op1,
1018 const BinaryOperator &I,
1019 InstCombiner &IC);
David Majnemer37f8f442013-07-04 21:17:49 +00001020
1021/// \brief Used to maintain state for visitUDivOperand().
1022struct UDivFoldAction {
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +00001023 /// Informs visitUDiv() how to fold this operand. This can be zero if this
1024 /// action joins two actions together.
1025 FoldUDivOperandCb FoldAction;
David Majnemer37f8f442013-07-04 21:17:49 +00001026
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +00001027 /// Which operand to fold.
1028 Value *OperandToFold;
1029
David Majnemer37f8f442013-07-04 21:17:49 +00001030 union {
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +00001031 /// The instruction returned when FoldAction is invoked.
1032 Instruction *FoldResult;
David Majnemer37f8f442013-07-04 21:17:49 +00001033
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +00001034 /// Stores the LHS action index if this action joins two actions together.
1035 size_t SelectLHSIdx;
David Majnemer37f8f442013-07-04 21:17:49 +00001036 };
1037
1038 UDivFoldAction(FoldUDivOperandCb FA, Value *InputOperand)
Craig Topperf40110f2014-04-25 05:29:35 +00001039 : FoldAction(FA), OperandToFold(InputOperand), FoldResult(nullptr) {}
David Majnemer37f8f442013-07-04 21:17:49 +00001040 UDivFoldAction(FoldUDivOperandCb FA, Value *InputOperand, size_t SLHS)
1041 : FoldAction(FA), OperandToFold(InputOperand), SelectLHSIdx(SLHS) {}
1042};
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +00001043
1044} // end anonymous namespace
David Majnemer37f8f442013-07-04 21:17:49 +00001045
1046// X udiv 2^C -> X >> C
1047static Instruction *foldUDivPow2Cst(Value *Op0, Value *Op1,
1048 const BinaryOperator &I, InstCombiner &IC) {
Simon Pilgrim94cc89d2018-02-08 14:46:10 +00001049 Constant *C1 = getLogBase2(Op0->getType(), cast<Constant>(Op1));
1050 if (!C1)
1051 llvm_unreachable("Failed to constant fold udiv -> logbase2");
1052 BinaryOperator *LShr = BinaryOperator::CreateLShr(Op0, C1);
Suyog Sarda65f5ae92014-10-07 12:04:07 +00001053 if (I.isExact())
1054 LShr->setIsExact();
David Majnemer37f8f442013-07-04 21:17:49 +00001055 return LShr;
1056}
1057
1058// X udiv C, where C >= signbit
1059static Instruction *foldUDivNegCst(Value *Op0, Value *Op1,
1060 const BinaryOperator &I, InstCombiner &IC) {
Simon Pilgrim9620f4b2018-02-09 10:43:59 +00001061 Value *ICI = IC.Builder.CreateICmpULT(Op0, cast<Constant>(Op1));
David Majnemer37f8f442013-07-04 21:17:49 +00001062 return SelectInst::Create(ICI, Constant::getNullValue(I.getType()),
1063 ConstantInt::get(I.getType(), 1));
1064}
1065
1066// X udiv (C1 << N), where C1 is "1<<C2" --> X >> (N+C2)
Andrea Di Biagioa82d52d2016-09-26 12:07:23 +00001067// X udiv (zext (C1 << N)), where C1 is "1<<C2" --> X >> (N+C2)
David Majnemer37f8f442013-07-04 21:17:49 +00001068static Instruction *foldUDivShl(Value *Op0, Value *Op1, const BinaryOperator &I,
1069 InstCombiner &IC) {
Andrea Di Biagioa82d52d2016-09-26 12:07:23 +00001070 Value *ShiftLeft;
1071 if (!match(Op1, m_ZExt(m_Value(ShiftLeft))))
1072 ShiftLeft = Op1;
David Majnemer37f8f442013-07-04 21:17:49 +00001073
Simon Pilgrim2a90acd2018-02-08 15:19:38 +00001074 Constant *CI;
Andrea Di Biagioa82d52d2016-09-26 12:07:23 +00001075 Value *N;
Simon Pilgrim2a90acd2018-02-08 15:19:38 +00001076 if (!match(ShiftLeft, m_Shl(m_Constant(CI), m_Value(N))))
Andrea Di Biagioa82d52d2016-09-26 12:07:23 +00001077 llvm_unreachable("match should never fail here!");
Simon Pilgrim2a90acd2018-02-08 15:19:38 +00001078 Constant *Log2Base = getLogBase2(N->getType(), CI);
1079 if (!Log2Base)
1080 llvm_unreachable("getLogBase2 should never fail here!");
1081 N = IC.Builder.CreateAdd(N, Log2Base);
Andrea Di Biagioa82d52d2016-09-26 12:07:23 +00001082 if (Op1 != ShiftLeft)
Craig Topperbb4069e2017-07-07 23:16:26 +00001083 N = IC.Builder.CreateZExt(N, Op1->getType());
David Majnemer37f8f442013-07-04 21:17:49 +00001084 BinaryOperator *LShr = BinaryOperator::CreateLShr(Op0, N);
Suyog Sarda65f5ae92014-10-07 12:04:07 +00001085 if (I.isExact())
1086 LShr->setIsExact();
David Majnemer37f8f442013-07-04 21:17:49 +00001087 return LShr;
1088}
1089
1090// \brief Recursively visits the possible right hand operands of a udiv
1091// instruction, seeing through select instructions, to determine if we can
1092// replace the udiv with something simpler. If we find that an operand is not
1093// able to simplify the udiv, we abort the entire transformation.
1094static size_t visitUDivOperand(Value *Op0, Value *Op1, const BinaryOperator &I,
1095 SmallVectorImpl<UDivFoldAction> &Actions,
1096 unsigned Depth = 0) {
1097 // Check to see if this is an unsigned division with an exact power of 2,
1098 // if so, convert to a right shift.
1099 if (match(Op1, m_Power2())) {
1100 Actions.push_back(UDivFoldAction(foldUDivPow2Cst, Op1));
1101 return Actions.size();
1102 }
1103
Simon Pilgrim9620f4b2018-02-09 10:43:59 +00001104 // X udiv C, where C >= signbit
1105 if (match(Op1, m_Negative())) {
1106 Actions.push_back(UDivFoldAction(foldUDivNegCst, Op1));
1107 return Actions.size();
1108 }
David Majnemer37f8f442013-07-04 21:17:49 +00001109
1110 // X udiv (C1 << N), where C1 is "1<<C2" --> X >> (N+C2)
1111 if (match(Op1, m_Shl(m_Power2(), m_Value())) ||
1112 match(Op1, m_ZExt(m_Shl(m_Power2(), m_Value())))) {
1113 Actions.push_back(UDivFoldAction(foldUDivShl, Op1));
1114 return Actions.size();
1115 }
1116
1117 // The remaining tests are all recursive, so bail out if we hit the limit.
1118 if (Depth++ == MaxDepth)
1119 return 0;
1120
1121 if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
David Majnemer492e6122014-08-30 09:19:05 +00001122 if (size_t LHSIdx =
1123 visitUDivOperand(Op0, SI->getOperand(1), I, Actions, Depth))
1124 if (visitUDivOperand(Op0, SI->getOperand(2), I, Actions, Depth)) {
1125 Actions.push_back(UDivFoldAction(nullptr, Op1, LHSIdx - 1));
David Majnemer37f8f442013-07-04 21:17:49 +00001126 return Actions.size();
1127 }
1128
1129 return 0;
1130}
1131
Sanjay Patelbb789382017-08-24 22:54:01 +00001132/// If we have zero-extended operands of an unsigned div or rem, we may be able
1133/// to narrow the operation (sink the zext below the math).
1134static Instruction *narrowUDivURem(BinaryOperator &I,
1135 InstCombiner::BuilderTy &Builder) {
1136 Instruction::BinaryOps Opcode = I.getOpcode();
1137 Value *N = I.getOperand(0);
1138 Value *D = I.getOperand(1);
1139 Type *Ty = I.getType();
1140 Value *X, *Y;
1141 if (match(N, m_ZExt(m_Value(X))) && match(D, m_ZExt(m_Value(Y))) &&
1142 X->getType() == Y->getType() && (N->hasOneUse() || D->hasOneUse())) {
1143 // udiv (zext X), (zext Y) --> zext (udiv X, Y)
1144 // urem (zext X), (zext Y) --> zext (urem X, Y)
1145 Value *NarrowOp = Builder.CreateBinOp(Opcode, X, Y);
1146 return new ZExtInst(NarrowOp, Ty);
1147 }
1148
1149 Constant *C;
1150 if ((match(N, m_OneUse(m_ZExt(m_Value(X)))) && match(D, m_Constant(C))) ||
1151 (match(D, m_OneUse(m_ZExt(m_Value(X)))) && match(N, m_Constant(C)))) {
1152 // If the constant is the same in the smaller type, use the narrow version.
1153 Constant *TruncC = ConstantExpr::getTrunc(C, X->getType());
1154 if (ConstantExpr::getZExt(TruncC, Ty) != C)
1155 return nullptr;
1156
1157 // udiv (zext X), C --> zext (udiv X, C')
1158 // urem (zext X), C --> zext (urem X, C')
1159 // udiv C, (zext X) --> zext (udiv C', X)
1160 // urem C, (zext X) --> zext (urem C', X)
1161 Value *NarrowOp = isa<Constant>(D) ? Builder.CreateBinOp(Opcode, X, TruncC)
1162 : Builder.CreateBinOp(Opcode, TruncC, X);
1163 return new ZExtInst(NarrowOp, Ty);
1164 }
1165
1166 return nullptr;
1167}
1168
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001169Instruction *InstCombiner::visitUDiv(BinaryOperator &I) {
1170 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1171
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001172 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001173 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001174
Craig Toppera4205622017-06-09 03:21:29 +00001175 if (Value *V = SimplifyUDivInst(Op0, Op1, SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001176 return replaceInstUsesWith(I, V);
Duncan Sands771e82a2011-01-28 16:51:11 +00001177
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001178 // Handle the integer div common cases
1179 if (Instruction *Common = commonIDivTransforms(I))
1180 return Common;
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001181
Benjamin Kramerd4a64712012-08-30 15:07:40 +00001182 // (x lshr C1) udiv C2 --> x udiv (C2 << C1)
David Majnemera2521382014-10-13 21:48:30 +00001183 {
Benjamin Kramer9c0a8072012-08-28 13:08:13 +00001184 Value *X;
David Majnemera2521382014-10-13 21:48:30 +00001185 const APInt *C1, *C2;
1186 if (match(Op0, m_LShr(m_Value(X), m_APInt(C1))) &&
1187 match(Op1, m_APInt(C2))) {
1188 bool Overflow;
1189 APInt C2ShlC1 = C2->ushl_ov(*C1, Overflow);
David Majnemera3aeb152014-11-22 18:16:54 +00001190 if (!Overflow) {
1191 bool IsExact = I.isExact() && match(Op0, m_Exact(m_Value()));
1192 BinaryOperator *BO = BinaryOperator::CreateUDiv(
David Majnemera2521382014-10-13 21:48:30 +00001193 X, ConstantInt::get(X->getType(), C2ShlC1));
David Majnemera3aeb152014-11-22 18:16:54 +00001194 if (IsExact)
1195 BO->setIsExact();
1196 return BO;
1197 }
David Majnemera2521382014-10-13 21:48:30 +00001198 }
Nadav Rotem11935b22012-08-28 10:01:43 +00001199 }
1200
Sanjay Patelbb789382017-08-24 22:54:01 +00001201 if (Instruction *NarrowDiv = narrowUDivURem(I, Builder))
1202 return NarrowDiv;
Benjamin Kramer9aa91b12011-04-30 18:16:07 +00001203
David Majnemer37f8f442013-07-04 21:17:49 +00001204 // (LHS udiv (select (select (...)))) -> (LHS >> (select (select (...))))
1205 SmallVector<UDivFoldAction, 6> UDivActions;
1206 if (visitUDivOperand(Op0, Op1, I, UDivActions))
1207 for (unsigned i = 0, e = UDivActions.size(); i != e; ++i) {
1208 FoldUDivOperandCb Action = UDivActions[i].FoldAction;
1209 Value *ActionOp1 = UDivActions[i].OperandToFold;
1210 Instruction *Inst;
1211 if (Action)
1212 Inst = Action(Op0, ActionOp1, I, *this);
1213 else {
1214 // This action joins two actions together. The RHS of this action is
1215 // simply the last action we processed, we saved the LHS action index in
1216 // the joining action.
1217 size_t SelectRHSIdx = i - 1;
1218 Value *SelectRHS = UDivActions[SelectRHSIdx].FoldResult;
1219 size_t SelectLHSIdx = UDivActions[i].SelectLHSIdx;
1220 Value *SelectLHS = UDivActions[SelectLHSIdx].FoldResult;
1221 Inst = SelectInst::Create(cast<SelectInst>(ActionOp1)->getCondition(),
1222 SelectLHS, SelectRHS);
1223 }
1224
1225 // If this is the last action to process, return it to the InstCombiner.
1226 // Otherwise, we insert it before the UDiv and record it so that we may
1227 // use it as part of a joining action (i.e., a SelectInst).
1228 if (e - i != 1) {
1229 Inst->insertBefore(&I);
1230 UDivActions[i].FoldResult = Inst;
1231 } else
1232 return Inst;
1233 }
1234
Craig Topperf40110f2014-04-25 05:29:35 +00001235 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001236}
1237
1238Instruction *InstCombiner::visitSDiv(BinaryOperator &I) {
1239 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1240
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001241 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001242 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001243
Craig Toppera4205622017-06-09 03:21:29 +00001244 if (Value *V = SimplifySDivInst(Op0, Op1, SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001245 return replaceInstUsesWith(I, V);
Duncan Sands771e82a2011-01-28 16:51:11 +00001246
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001247 // Handle the integer div common cases
1248 if (Instruction *Common = commonIDivTransforms(I))
1249 return Common;
1250
Sanjay Patelc6ada532016-06-27 17:25:57 +00001251 const APInt *Op1C;
Sanjay Patelbedd1f92016-06-27 18:38:40 +00001252 if (match(Op1, m_APInt(Op1C))) {
1253 // sdiv X, -1 == -X
1254 if (Op1C->isAllOnesValue())
1255 return BinaryOperator::CreateNeg(Op0);
1256
1257 // sdiv exact X, C --> ashr exact X, log2(C)
1258 if (I.isExact() && Op1C->isNonNegative() && Op1C->isPowerOf2()) {
1259 Value *ShAmt = ConstantInt::get(Op1->getType(), Op1C->exactLogBase2());
1260 return BinaryOperator::CreateExactAShr(Op0, ShAmt, I.getName());
1261 }
Sanjay Patel59ed2ff2016-06-27 22:27:11 +00001262
1263 // If the dividend is sign-extended and the constant divisor is small enough
1264 // to fit in the source type, shrink the division to the narrower type:
1265 // (sext X) sdiv C --> sext (X sdiv C)
1266 Value *Op0Src;
1267 if (match(Op0, m_OneUse(m_SExt(m_Value(Op0Src)))) &&
1268 Op0Src->getType()->getScalarSizeInBits() >= Op1C->getMinSignedBits()) {
1269
1270 // In the general case, we need to make sure that the dividend is not the
1271 // minimum signed value because dividing that by -1 is UB. But here, we
1272 // know that the -1 divisor case is already handled above.
1273
1274 Constant *NarrowDivisor =
1275 ConstantExpr::getTrunc(cast<Constant>(Op1), Op0Src->getType());
Craig Topperbb4069e2017-07-07 23:16:26 +00001276 Value *NarrowOp = Builder.CreateSDiv(Op0Src, NarrowDivisor);
Sanjay Patel59ed2ff2016-06-27 22:27:11 +00001277 return new SExtInst(NarrowOp, Op0->getType());
1278 }
Benjamin Kramer72196f32014-01-19 15:24:22 +00001279 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001280
Benjamin Kramer72196f32014-01-19 15:24:22 +00001281 if (Constant *RHS = dyn_cast<Constant>(Op1)) {
David Majnemerf28e2a42014-07-02 06:42:13 +00001282 // X/INT_MIN -> X == INT_MIN
1283 if (RHS->isMinSignedValue())
Craig Topperbb4069e2017-07-07 23:16:26 +00001284 return new ZExtInst(Builder.CreateICmpEQ(Op0, Op1), I.getType());
David Majnemerf28e2a42014-07-02 06:42:13 +00001285
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001286 // -X/C --> X/-C provided the negation doesn't overflow.
David Majnemerfa4699e2014-11-22 20:00:34 +00001287 Value *X;
1288 if (match(Op0, m_NSWSub(m_Zero(), m_Value(X)))) {
1289 auto *BO = BinaryOperator::CreateSDiv(X, ConstantExpr::getNeg(RHS));
1290 BO->setIsExact(I.isExact());
1291 return BO;
1292 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001293 }
1294
1295 // If the sign bits of both operands are zero (i.e. we can prove they are
1296 // unsigned inputs), turn this into a udiv.
Craig Topperbcfd2d12017-04-20 16:56:25 +00001297 APInt Mask(APInt::getSignMask(I.getType()->getScalarSizeInBits()));
Craig Topperf2484682017-04-17 01:51:19 +00001298 if (MaskedValueIsZero(Op0, Mask, 0, &I)) {
1299 if (MaskedValueIsZero(Op1, Mask, 0, &I)) {
1300 // X sdiv Y -> X udiv Y, iff X and Y don't have sign bit set
1301 auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
1302 BO->setIsExact(I.isExact());
1303 return BO;
1304 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001305
Craig Topperd4039f72017-05-25 21:51:12 +00001306 if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/ true, 0, &I)) {
Craig Topperf2484682017-04-17 01:51:19 +00001307 // X sdiv (1 << Y) -> X udiv (1 << Y) ( -> X u>> Y)
1308 // Safe because the only negative value (1 << Y) can take on is
1309 // INT_MIN, and X sdiv INT_MIN == X udiv INT_MIN == 0 if X doesn't have
1310 // the sign bit set.
1311 auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
1312 BO->setIsExact(I.isExact());
1313 return BO;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001314 }
1315 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001316
Craig Topperf40110f2014-04-25 05:29:35 +00001317 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001318}
1319
Shuxin Yang320f52a2013-01-14 22:48:41 +00001320/// CvtFDivConstToReciprocal tries to convert X/C into X*1/C if C not a special
1321/// FP value and:
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001322/// 1) 1/C is exact, or
Shuxin Yang320f52a2013-01-14 22:48:41 +00001323/// 2) reciprocal is allowed.
Sylvestre Ledru149e2812013-05-14 23:36:24 +00001324/// If the conversion was successful, the simplified expression "X * 1/C" is
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +00001325/// returned; otherwise, nullptr is returned.
Suyog Sardaea205512014-10-07 11:56:06 +00001326static Instruction *CvtFDivConstToReciprocal(Value *Dividend, Constant *Divisor,
Shuxin Yang320f52a2013-01-14 22:48:41 +00001327 bool AllowReciprocal) {
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001328 if (!isa<ConstantFP>(Divisor)) // TODO: handle vectors.
Craig Topperf40110f2014-04-25 05:29:35 +00001329 return nullptr;
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001330
1331 const APFloat &FpVal = cast<ConstantFP>(Divisor)->getValueAPF();
Shuxin Yang320f52a2013-01-14 22:48:41 +00001332 APFloat Reciprocal(FpVal.getSemantics());
1333 bool Cvt = FpVal.getExactInverse(&Reciprocal);
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001334
Michael Gottesman3cb77ab2013-06-19 21:23:18 +00001335 if (!Cvt && AllowReciprocal && FpVal.isFiniteNonZero()) {
Shuxin Yang320f52a2013-01-14 22:48:41 +00001336 Reciprocal = APFloat(FpVal.getSemantics(), 1.0f);
1337 (void)Reciprocal.divide(FpVal, APFloat::rmNearestTiesToEven);
1338 Cvt = !Reciprocal.isDenormal();
1339 }
1340
1341 if (!Cvt)
Craig Topperf40110f2014-04-25 05:29:35 +00001342 return nullptr;
Shuxin Yang320f52a2013-01-14 22:48:41 +00001343
1344 ConstantFP *R;
1345 R = ConstantFP::get(Dividend->getType()->getContext(), Reciprocal);
1346 return BinaryOperator::CreateFMul(Dividend, R);
1347}
1348
Frits van Bommel2a559512011-01-29 17:50:27 +00001349Instruction *InstCombiner::visitFDiv(BinaryOperator &I) {
1350 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1351
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001352 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001353 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001354
Craig Toppera4205622017-06-09 03:21:29 +00001355 if (Value *V = SimplifyFDivInst(Op0, Op1, I.getFastMathFlags(),
1356 SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001357 return replaceInstUsesWith(I, V);
Frits van Bommel2a559512011-01-29 17:50:27 +00001358
Stephen Lina9b57f62013-07-20 07:13:13 +00001359 if (isa<Constant>(Op0))
1360 if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
1361 if (Instruction *R = FoldOpIntoSelect(I, SI))
1362 return R;
1363
Sanjay Patel629c4112017-11-06 16:27:15 +00001364 bool AllowReassociate = I.isFast();
Shuxin Yang320f52a2013-01-14 22:48:41 +00001365 bool AllowReciprocal = I.hasAllowReciprocal();
Benjamin Kramer8564e0d2011-03-30 15:42:35 +00001366
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001367 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
Stephen Lina9b57f62013-07-20 07:13:13 +00001368 if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
1369 if (Instruction *R = FoldOpIntoSelect(I, SI))
1370 return R;
1371
Shuxin Yang320f52a2013-01-14 22:48:41 +00001372 if (AllowReassociate) {
Craig Topperf40110f2014-04-25 05:29:35 +00001373 Constant *C1 = nullptr;
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001374 Constant *C2 = Op1C;
Shuxin Yang320f52a2013-01-14 22:48:41 +00001375 Value *X;
Craig Topperf40110f2014-04-25 05:29:35 +00001376 Instruction *Res = nullptr;
Shuxin Yang320f52a2013-01-14 22:48:41 +00001377
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001378 if (match(Op0, m_FMul(m_Value(X), m_Constant(C1)))) {
Shuxin Yang320f52a2013-01-14 22:48:41 +00001379 // (X*C1)/C2 => X * (C1/C2)
1380 //
1381 Constant *C = ConstantExpr::getFDiv(C1, C2);
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001382 if (isNormalFp(C))
Shuxin Yang320f52a2013-01-14 22:48:41 +00001383 Res = BinaryOperator::CreateFMul(X, C);
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001384 } else if (match(Op0, m_FDiv(m_Value(X), m_Constant(C1)))) {
Shuxin Yang320f52a2013-01-14 22:48:41 +00001385 // (X/C1)/C2 => X /(C2*C1) [=> X * 1/(C2*C1) if reciprocal is allowed]
Shuxin Yang320f52a2013-01-14 22:48:41 +00001386 Constant *C = ConstantExpr::getFMul(C1, C2);
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001387 if (isNormalFp(C)) {
1388 Res = CvtFDivConstToReciprocal(X, C, AllowReciprocal);
Shuxin Yang320f52a2013-01-14 22:48:41 +00001389 if (!Res)
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001390 Res = BinaryOperator::CreateFDiv(X, C);
Shuxin Yang320f52a2013-01-14 22:48:41 +00001391 }
1392 }
1393
1394 if (Res) {
1395 Res->setFastMathFlags(I.getFastMathFlags());
1396 return Res;
1397 }
1398 }
1399
1400 // X / C => X * 1/C
Owen Anderson4557a152014-01-16 21:07:52 +00001401 if (Instruction *T = CvtFDivConstToReciprocal(Op0, Op1C, AllowReciprocal)) {
1402 T->copyFastMathFlags(&I);
Shuxin Yang320f52a2013-01-14 22:48:41 +00001403 return T;
Owen Anderson4557a152014-01-16 21:07:52 +00001404 }
Shuxin Yang320f52a2013-01-14 22:48:41 +00001405
Craig Topperf40110f2014-04-25 05:29:35 +00001406 return nullptr;
Shuxin Yang320f52a2013-01-14 22:48:41 +00001407 }
1408
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001409 if (AllowReassociate && isa<Constant>(Op0)) {
1410 Constant *C1 = cast<Constant>(Op0), *C2;
Craig Topperf40110f2014-04-25 05:29:35 +00001411 Constant *Fold = nullptr;
Shuxin Yang320f52a2013-01-14 22:48:41 +00001412 Value *X;
1413 bool CreateDiv = true;
1414
1415 // C1 / (X*C2) => (C1/C2) / X
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001416 if (match(Op1, m_FMul(m_Value(X), m_Constant(C2))))
Shuxin Yang320f52a2013-01-14 22:48:41 +00001417 Fold = ConstantExpr::getFDiv(C1, C2);
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001418 else if (match(Op1, m_FDiv(m_Value(X), m_Constant(C2)))) {
Shuxin Yang320f52a2013-01-14 22:48:41 +00001419 // C1 / (X/C2) => (C1*C2) / X
1420 Fold = ConstantExpr::getFMul(C1, C2);
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001421 } else if (match(Op1, m_FDiv(m_Constant(C2), m_Value(X)))) {
Shuxin Yang320f52a2013-01-14 22:48:41 +00001422 // C1 / (C2/X) => (C1/C2) * X
1423 Fold = ConstantExpr::getFDiv(C1, C2);
1424 CreateDiv = false;
1425 }
1426
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001427 if (Fold && isNormalFp(Fold)) {
1428 Instruction *R = CreateDiv ? BinaryOperator::CreateFDiv(Fold, X)
1429 : BinaryOperator::CreateFMul(X, Fold);
1430 R->setFastMathFlags(I.getFastMathFlags());
1431 return R;
Shuxin Yang320f52a2013-01-14 22:48:41 +00001432 }
Craig Topperf40110f2014-04-25 05:29:35 +00001433 return nullptr;
Shuxin Yang320f52a2013-01-14 22:48:41 +00001434 }
1435
1436 if (AllowReassociate) {
1437 Value *X, *Y;
Craig Topperf40110f2014-04-25 05:29:35 +00001438 Value *NewInst = nullptr;
1439 Instruction *SimpR = nullptr;
Shuxin Yang320f52a2013-01-14 22:48:41 +00001440
1441 if (Op0->hasOneUse() && match(Op0, m_FDiv(m_Value(X), m_Value(Y)))) {
1442 // (X/Y) / Z => X / (Y*Z)
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001443 if (!isa<Constant>(Y) || !isa<Constant>(Op1)) {
Craig Topperbb4069e2017-07-07 23:16:26 +00001444 NewInst = Builder.CreateFMul(Y, Op1);
Owen Anderson1664dc82014-01-20 07:44:53 +00001445 if (Instruction *RI = dyn_cast<Instruction>(NewInst)) {
1446 FastMathFlags Flags = I.getFastMathFlags();
1447 Flags &= cast<Instruction>(Op0)->getFastMathFlags();
1448 RI->setFastMathFlags(Flags);
1449 }
Shuxin Yang320f52a2013-01-14 22:48:41 +00001450 SimpR = BinaryOperator::CreateFDiv(X, NewInst);
1451 }
1452 } else if (Op1->hasOneUse() && match(Op1, m_FDiv(m_Value(X), m_Value(Y)))) {
1453 // Z / (X/Y) => Z*Y / X
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001454 if (!isa<Constant>(Y) || !isa<Constant>(Op0)) {
Craig Topperbb4069e2017-07-07 23:16:26 +00001455 NewInst = Builder.CreateFMul(Op0, Y);
Owen Anderson1664dc82014-01-20 07:44:53 +00001456 if (Instruction *RI = dyn_cast<Instruction>(NewInst)) {
1457 FastMathFlags Flags = I.getFastMathFlags();
1458 Flags &= cast<Instruction>(Op1)->getFastMathFlags();
1459 RI->setFastMathFlags(Flags);
1460 }
Shuxin Yang320f52a2013-01-14 22:48:41 +00001461 SimpR = BinaryOperator::CreateFDiv(NewInst, X);
1462 }
1463 }
1464
1465 if (NewInst) {
1466 if (Instruction *T = dyn_cast<Instruction>(NewInst))
1467 T->setDebugLoc(I.getDebugLoc());
1468 SimpR->setFastMathFlags(I.getFastMathFlags());
1469 return SimpR;
Benjamin Kramer8564e0d2011-03-30 15:42:35 +00001470 }
1471 }
1472
Dmitry Venikove5fbf592018-01-11 06:33:00 +00001473 if (AllowReassociate &&
1474 Op0->hasOneUse() && Op1->hasOneUse()) {
1475 Value *A;
1476 // sin(a) / cos(a) -> tan(a)
1477 if (match(Op0, m_Intrinsic<Intrinsic::sin>(m_Value(A))) &&
1478 match(Op1, m_Intrinsic<Intrinsic::cos>(m_Specific(A)))) {
1479 if (hasUnaryFloatFn(&TLI, I.getType(), LibFunc_tan,
1480 LibFunc_tanf, LibFunc_tanl)) {
1481 IRBuilder<> B(&I);
1482 IRBuilder<>::FastMathFlagGuard Guard(B);
1483 B.setFastMathFlags(I.getFastMathFlags());
Benjamin Kramer738e6e72018-01-11 15:33:21 +00001484 Value *Tan = emitUnaryFloatFnCall(
1485 A, TLI.getName(LibFunc_tan), B,
1486 CallSite(Op0).getCalledFunction()->getAttributes());
Dmitry Venikove5fbf592018-01-11 06:33:00 +00001487 return replaceInstUsesWith(I, Tan);
1488 }
1489 }
1490
1491 // cos(a) / sin(a) -> 1/tan(a)
1492 if (match(Op0, m_Intrinsic<Intrinsic::cos>(m_Value(A))) &&
1493 match(Op1, m_Intrinsic<Intrinsic::sin>(m_Specific(A)))) {
1494 if (hasUnaryFloatFn(&TLI, I.getType(), LibFunc_tan,
1495 LibFunc_tanf, LibFunc_tanl)) {
1496 IRBuilder<> B(&I);
1497 IRBuilder<>::FastMathFlagGuard Guard(B);
1498 B.setFastMathFlags(I.getFastMathFlags());
Benjamin Kramer44993ed2018-01-11 15:19:02 +00001499 Value *Tan = emitUnaryFloatFnCall(
1500 A, TLI.getName(LibFunc_tan), B,
1501 CallSite(Op0).getCalledFunction()->getAttributes());
Dmitry Venikove5fbf592018-01-11 06:33:00 +00001502 Value *One = ConstantFP::get(Tan->getType(), 1.0);
1503 Value *Div = B.CreateFDiv(One, Tan);
1504 return replaceInstUsesWith(I, Div);
1505 }
1506 }
1507 }
1508
Sanjay Patel1998cc62018-02-12 18:38:35 +00001509 // -X / -Y -> X / Y
1510 Value *X, *Y;
1511 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y)))) {
1512 I.setOperand(0, X);
1513 I.setOperand(1, Y);
Matt Arsenaultfdb78f82017-01-10 23:08:54 +00001514 return &I;
1515 }
1516
Sanjay Patel4a4f35f2018-02-12 19:39:21 +00001517 // X / (X * Y) --> 1.0 / Y
1518 // Reassociate to (X / X -> 1.0) is legal when NaNs are not allowed.
1519 // We can ignore the possibility that X is infinity because INF/INF is NaN.
1520 if (I.hasNoNaNs() && I.hasAllowReassoc() &&
1521 match(Op1, m_c_FMul(m_Specific(Op0), m_Value(Y)))) {
1522 I.setOperand(0, ConstantFP::get(I.getType(), 1.0));
1523 I.setOperand(1, Y);
1524 return &I;
1525 }
1526
Craig Topperf40110f2014-04-25 05:29:35 +00001527 return nullptr;
Frits van Bommel2a559512011-01-29 17:50:27 +00001528}
1529
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001530/// This function implements the transforms common to both integer remainder
1531/// instructions (urem and srem). It is called by the visitors to those integer
1532/// remainder instructions.
1533/// @brief Common integer remainder transforms
1534Instruction *InstCombiner::commonIRemTransforms(BinaryOperator &I) {
1535 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1536
Chris Lattner7c99f192011-05-22 18:18:41 +00001537 // The RHS is known non-zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001538 if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I)) {
Chris Lattner7c99f192011-05-22 18:18:41 +00001539 I.setOperand(1, V);
1540 return &I;
1541 }
1542
Duncan Sandsa3e36992011-05-02 16:27:02 +00001543 // Handle cases involving: rem X, (select Cond, Y, Z)
Sanjay Patelae2e3a42017-10-06 23:20:16 +00001544 if (simplifyDivRemOfSelectWithZeroOp(I))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001545 return &I;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001546
Benjamin Kramer72196f32014-01-19 15:24:22 +00001547 if (isa<Constant>(Op1)) {
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001548 if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
1549 if (SelectInst *SI = dyn_cast<SelectInst>(Op0I)) {
1550 if (Instruction *R = FoldOpIntoSelect(I, SI))
1551 return R;
Craig Topperfb71b7d2017-04-14 19:20:12 +00001552 } else if (auto *PN = dyn_cast<PHINode>(Op0I)) {
Sanjoy Dasb7e861a2016-06-05 21:17:04 +00001553 const APInt *Op1Int;
1554 if (match(Op1, m_APInt(Op1Int)) && !Op1Int->isMinValue() &&
1555 (I.getOpcode() == Instruction::URem ||
1556 !Op1Int->isMinSignedValue())) {
Craig Topperfb71b7d2017-04-14 19:20:12 +00001557 // foldOpIntoPhi will speculate instructions to the end of the PHI's
Sanjoy Dasb7e861a2016-06-05 21:17:04 +00001558 // predecessor blocks, so do this only if we know the srem or urem
1559 // will not fault.
Craig Topperfb71b7d2017-04-14 19:20:12 +00001560 if (Instruction *NV = foldOpIntoPhi(I, PN))
Sanjoy Dasb7e861a2016-06-05 21:17:04 +00001561 return NV;
1562 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001563 }
1564
1565 // See if we can fold away this rem instruction.
1566 if (SimplifyDemandedInstructionBits(I))
1567 return &I;
1568 }
1569 }
1570
Craig Topperf40110f2014-04-25 05:29:35 +00001571 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001572}
1573
1574Instruction *InstCombiner::visitURem(BinaryOperator &I) {
1575 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1576
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001577 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001578 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001579
Craig Toppera4205622017-06-09 03:21:29 +00001580 if (Value *V = SimplifyURemInst(Op0, Op1, SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001581 return replaceInstUsesWith(I, V);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001582
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001583 if (Instruction *common = commonIRemTransforms(I))
1584 return common;
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001585
Sanjay Patelbb789382017-08-24 22:54:01 +00001586 if (Instruction *NarrowRem = narrowUDivURem(I, Builder))
1587 return NarrowRem;
David Majnemer6c30f492013-05-12 00:07:05 +00001588
David Majnemer470b0772013-05-11 09:01:28 +00001589 // X urem Y -> X and Y-1, where Y is a power of 2,
Craig Topperd4039f72017-05-25 21:51:12 +00001590 if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/ true, 0, &I)) {
Chris Lattner6b657ae2011-02-10 05:36:31 +00001591 Constant *N1 = Constant::getAllOnesValue(I.getType());
Craig Topperbb4069e2017-07-07 23:16:26 +00001592 Value *Add = Builder.CreateAdd(Op1, N1);
Chris Lattner6b657ae2011-02-10 05:36:31 +00001593 return BinaryOperator::CreateAnd(Op0, Add);
1594 }
1595
Nick Lewycky7459be62013-07-13 01:16:47 +00001596 // 1 urem X -> zext(X != 1)
1597 if (match(Op0, m_One())) {
Craig Topperbb4069e2017-07-07 23:16:26 +00001598 Value *Cmp = Builder.CreateICmpNE(Op1, Op0);
1599 Value *Ext = Builder.CreateZExt(Cmp, I.getType());
Sanjay Patel4b198802016-02-01 22:23:39 +00001600 return replaceInstUsesWith(I, Ext);
Nick Lewycky7459be62013-07-13 01:16:47 +00001601 }
1602
Sanjay Patel30ef70b2016-09-22 22:36:26 +00001603 // X urem C -> X < C ? X : X - C, where C >= signbit.
Simon Pilgrim1889f262018-02-08 18:36:01 +00001604 if (match(Op1, m_Negative())) {
Craig Topperbb4069e2017-07-07 23:16:26 +00001605 Value *Cmp = Builder.CreateICmpULT(Op0, Op1);
1606 Value *Sub = Builder.CreateSub(Op0, Op1);
Sanjay Patel30ef70b2016-09-22 22:36:26 +00001607 return SelectInst::Create(Cmp, Op0, Sub);
1608 }
1609
Craig Topperf40110f2014-04-25 05:29:35 +00001610 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001611}
1612
1613Instruction *InstCombiner::visitSRem(BinaryOperator &I) {
1614 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1615
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001616 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001617 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001618
Craig Toppera4205622017-06-09 03:21:29 +00001619 if (Value *V = SimplifySRemInst(Op0, Op1, SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001620 return replaceInstUsesWith(I, V);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001621
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001622 // Handle the integer rem common cases
1623 if (Instruction *Common = commonIRemTransforms(I))
1624 return Common;
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001625
David Majnemerdb077302014-10-13 22:37:51 +00001626 {
1627 const APInt *Y;
1628 // X % -Y -> X % Y
Simon Pilgrima54e8e42018-02-08 19:00:45 +00001629 if (match(Op1, m_Negative(Y)) && !Y->isMinSignedValue()) {
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001630 Worklist.AddValue(I.getOperand(1));
David Majnemerdb077302014-10-13 22:37:51 +00001631 I.setOperand(1, ConstantInt::get(I.getType(), -*Y));
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001632 return &I;
1633 }
David Majnemerdb077302014-10-13 22:37:51 +00001634 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001635
1636 // If the sign bits of both operands are zero (i.e. we can prove they are
1637 // unsigned inputs), turn this into a urem.
Craig Topperbcfd2d12017-04-20 16:56:25 +00001638 APInt Mask(APInt::getSignMask(I.getType()->getScalarSizeInBits()));
Craig Topper1a18a7c2017-04-17 01:51:24 +00001639 if (MaskedValueIsZero(Op1, Mask, 0, &I) &&
1640 MaskedValueIsZero(Op0, Mask, 0, &I)) {
1641 // X srem Y -> X urem Y, iff X and Y don't have sign bit set
1642 return BinaryOperator::CreateURem(Op0, Op1, I.getName());
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001643 }
1644
1645 // If it's a constant vector, flip any negative values positive.
Chris Lattner0256be92012-01-27 03:08:05 +00001646 if (isa<ConstantVector>(Op1) || isa<ConstantDataVector>(Op1)) {
1647 Constant *C = cast<Constant>(Op1);
1648 unsigned VWidth = C->getType()->getVectorNumElements();
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001649
1650 bool hasNegative = false;
Chris Lattner0256be92012-01-27 03:08:05 +00001651 bool hasMissing = false;
1652 for (unsigned i = 0; i != VWidth; ++i) {
1653 Constant *Elt = C->getAggregateElement(i);
Craig Topperf40110f2014-04-25 05:29:35 +00001654 if (!Elt) {
Chris Lattner0256be92012-01-27 03:08:05 +00001655 hasMissing = true;
1656 break;
1657 }
1658
1659 if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elt))
Chris Lattnerb1a15122011-07-15 06:08:15 +00001660 if (RHS->isNegative())
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001661 hasNegative = true;
Chris Lattner0256be92012-01-27 03:08:05 +00001662 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001663
Chris Lattner0256be92012-01-27 03:08:05 +00001664 if (hasNegative && !hasMissing) {
Chris Lattner47a86bd2012-01-25 06:02:56 +00001665 SmallVector<Constant *, 16> Elts(VWidth);
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001666 for (unsigned i = 0; i != VWidth; ++i) {
Chris Lattner8213c8a2012-02-06 21:56:39 +00001667 Elts[i] = C->getAggregateElement(i); // Handle undef, etc.
Chris Lattner0256be92012-01-27 03:08:05 +00001668 if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elts[i])) {
Chris Lattnerb1a15122011-07-15 06:08:15 +00001669 if (RHS->isNegative())
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001670 Elts[i] = cast<ConstantInt>(ConstantExpr::getNeg(RHS));
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001671 }
1672 }
1673
1674 Constant *NewRHSV = ConstantVector::get(Elts);
Chris Lattner0256be92012-01-27 03:08:05 +00001675 if (NewRHSV != C) { // Don't loop on -MININT
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001676 Worklist.AddValue(I.getOperand(1));
1677 I.setOperand(1, NewRHSV);
1678 return &I;
1679 }
1680 }
1681 }
1682
Craig Topperf40110f2014-04-25 05:29:35 +00001683 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001684}
1685
1686Instruction *InstCombiner::visitFRem(BinaryOperator &I) {
Duncan Sandsa3e36992011-05-02 16:27:02 +00001687 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001688
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001689 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001690 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001691
Craig Toppera4205622017-06-09 03:21:29 +00001692 if (Value *V = SimplifyFRemInst(Op0, Op1, I.getFastMathFlags(),
1693 SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001694 return replaceInstUsesWith(I, V);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001695
Craig Topperf40110f2014-04-25 05:29:35 +00001696 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001697}