blob: 799493c655007084aaba528134cf8179cdbfab55 [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
Sanjay Patel8fdd87f2018-02-28 16:36:24 +0000254 if (Instruction *FoldedMul = foldBinOpIntoSelectOrPhi(I))
255 return FoldedMul;
256
Chris Lattner6b657ae2011-02-10 05:36:31 +0000257 // Simplify mul instructions with a constant RHS.
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000258 if (isa<Constant>(Op1)) {
Benjamin Kramer72196f32014-01-19 15:24:22 +0000259 // Canonicalize (X+C1)*CI -> X*CI+C1*CI.
Sanjay Patel8fdd87f2018-02-28 16:36:24 +0000260 Value *X;
261 Constant *C1;
262 if (match(Op0, m_OneUse(m_Add(m_Value(X), m_Constant(C1))))) {
263 Value *Mul = Builder.CreateMul(C1, Op1);
264 // Only go forward with the transform if C1*CI simplifies to a tidier
265 // constant.
266 if (!match(Mul, m_Mul(m_Value(), m_Value())))
267 return BinaryOperator::CreateAdd(Builder.CreateMul(X, Op1), Mul);
Benjamin Kramer72196f32014-01-19 15:24:22 +0000268 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000269 }
270
Sanjay Patel604cb9e2018-02-14 16:50:55 +0000271 // -X * C --> X * -C
272 Value *X, *Y;
273 Constant *Op1C;
274 if (match(Op0, m_Neg(m_Value(X))) && match(Op1, m_Constant(Op1C)))
275 return BinaryOperator::CreateMul(X, ConstantExpr::getNeg(Op1C));
276
277 // -X * -Y --> X * Y
278 if (match(Op0, m_Neg(m_Value(X))) && match(Op1, m_Neg(m_Value(Y)))) {
279 auto *NewMul = BinaryOperator::CreateMul(X, Y);
280 if (I.hasNoSignedWrap() &&
281 cast<OverflowingBinaryOperator>(Op0)->hasNoSignedWrap() &&
282 cast<OverflowingBinaryOperator>(Op1)->hasNoSignedWrap())
283 NewMul->setHasNoSignedWrap();
284 return NewMul;
David Majnemer8279a7502014-11-22 07:25:19 +0000285 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000286
287 // (X / Y) * Y = X - (X % Y)
288 // (X / Y) * -Y = (X % Y) - X
289 {
Sanjay Patela0a56822017-03-14 17:27:27 +0000290 Value *Y = Op1;
291 BinaryOperator *Div = dyn_cast<BinaryOperator>(Op0);
292 if (!Div || (Div->getOpcode() != Instruction::UDiv &&
293 Div->getOpcode() != Instruction::SDiv)) {
294 Y = Op0;
295 Div = dyn_cast<BinaryOperator>(Op1);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000296 }
Sanjay Patela0a56822017-03-14 17:27:27 +0000297 Value *Neg = dyn_castNegVal(Y);
298 if (Div && Div->hasOneUse() &&
299 (Div->getOperand(1) == Y || Div->getOperand(1) == Neg) &&
300 (Div->getOpcode() == Instruction::UDiv ||
301 Div->getOpcode() == Instruction::SDiv)) {
302 Value *X = Div->getOperand(0), *DivOp1 = Div->getOperand(1);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000303
Chris Lattner35315d02011-02-06 21:44:57 +0000304 // If the division is exact, X % Y is zero, so we end up with X or -X.
Sanjay Patela0a56822017-03-14 17:27:27 +0000305 if (Div->isExact()) {
306 if (DivOp1 == Y)
307 return replaceInstUsesWith(I, X);
308 return BinaryOperator::CreateNeg(X);
309 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000310
Sanjay Patela0a56822017-03-14 17:27:27 +0000311 auto RemOpc = Div->getOpcode() == Instruction::UDiv ? Instruction::URem
312 : Instruction::SRem;
Craig Topperbb4069e2017-07-07 23:16:26 +0000313 Value *Rem = Builder.CreateBinOp(RemOpc, X, DivOp1);
Sanjay Patela0a56822017-03-14 17:27:27 +0000314 if (DivOp1 == Y)
315 return BinaryOperator::CreateSub(X, Rem);
316 return BinaryOperator::CreateSub(Rem, X);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000317 }
318 }
319
320 /// i1 mul -> i1 and.
Craig Topperfde47232017-07-09 07:04:03 +0000321 if (I.getType()->isIntOrIntVectorTy(1))
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000322 return BinaryOperator::CreateAnd(Op0, Op1);
323
324 // X*(1 << Y) --> X << Y
325 // (1 << Y)*X --> X << Y
326 {
327 Value *Y;
David Majnemer546f8102014-11-22 08:57:02 +0000328 BinaryOperator *BO = nullptr;
329 bool ShlNSW = false;
330 if (match(Op0, m_Shl(m_One(), m_Value(Y)))) {
331 BO = BinaryOperator::CreateShl(Op1, Y);
David Majnemer087dc8b2015-01-04 07:36:02 +0000332 ShlNSW = cast<ShlOperator>(Op0)->hasNoSignedWrap();
David Majnemer8e6f6a92014-11-24 16:41:13 +0000333 } else if (match(Op1, m_Shl(m_One(), m_Value(Y)))) {
David Majnemer546f8102014-11-22 08:57:02 +0000334 BO = BinaryOperator::CreateShl(Op0, Y);
David Majnemer087dc8b2015-01-04 07:36:02 +0000335 ShlNSW = cast<ShlOperator>(Op1)->hasNoSignedWrap();
David Majnemer546f8102014-11-22 08:57:02 +0000336 }
337 if (BO) {
338 if (I.hasNoUnsignedWrap())
339 BO->setHasNoUnsignedWrap();
340 if (I.hasNoSignedWrap() && ShlNSW)
341 BO->setHasNoSignedWrap();
342 return BO;
343 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000344 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000345
Sanjay Patelcb8ac002018-02-13 20:41:22 +0000346 // (bool X) * Y --> X ? Y : 0
Sanjay Patel7558d862018-02-13 22:24:37 +0000347 // Y * (bool X) --> X ? Y : 0
Sanjay Patelcb8ac002018-02-13 20:41:22 +0000348 if (match(Op0, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
349 return SelectInst::Create(X, Op1, ConstantInt::get(I.getType(), 0));
Sanjay Patelcb8ac002018-02-13 20:41:22 +0000350 if (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
351 return SelectInst::Create(X, Op0, ConstantInt::get(I.getType(), 0));
352
Sanjay Patel7558d862018-02-13 22:24:37 +0000353 // (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);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000364
David Majnemera1cfd7c2016-12-30 00:28:58 +0000365 // Check for (mul (sext x), y), see if we can merge this into an
366 // integer mul followed by a sext.
367 if (SExtInst *Op0Conv = dyn_cast<SExtInst>(Op0)) {
368 // (mul (sext x), cst) --> (sext (mul x, cst'))
369 if (ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
370 if (Op0Conv->hasOneUse()) {
371 Constant *CI =
372 ConstantExpr::getTrunc(Op1C, Op0Conv->getOperand(0)->getType());
373 if (ConstantExpr::getSExt(CI, I.getType()) == Op1C &&
Craig Topper2b1fc322017-05-22 06:25:31 +0000374 willNotOverflowSignedMul(Op0Conv->getOperand(0), CI, I)) {
David Majnemera1cfd7c2016-12-30 00:28:58 +0000375 // Insert the new, smaller mul.
376 Value *NewMul =
Craig Topperbb4069e2017-07-07 23:16:26 +0000377 Builder.CreateNSWMul(Op0Conv->getOperand(0), CI, "mulconv");
David Majnemera1cfd7c2016-12-30 00:28:58 +0000378 return new SExtInst(NewMul, I.getType());
379 }
380 }
381 }
382
383 // (mul (sext x), (sext y)) --> (sext (mul int x, y))
384 if (SExtInst *Op1Conv = dyn_cast<SExtInst>(Op1)) {
385 // Only do this if x/y have the same type, if at last one of them has a
386 // single use (so we don't increase the number of sexts), and if the
387 // integer mul will not overflow.
388 if (Op0Conv->getOperand(0)->getType() ==
389 Op1Conv->getOperand(0)->getType() &&
390 (Op0Conv->hasOneUse() || Op1Conv->hasOneUse()) &&
Craig Topper2b1fc322017-05-22 06:25:31 +0000391 willNotOverflowSignedMul(Op0Conv->getOperand(0),
David Majnemera1cfd7c2016-12-30 00:28:58 +0000392 Op1Conv->getOperand(0), I)) {
393 // Insert the new integer mul.
Craig Topperbb4069e2017-07-07 23:16:26 +0000394 Value *NewMul = Builder.CreateNSWMul(
David Majnemera1cfd7c2016-12-30 00:28:58 +0000395 Op0Conv->getOperand(0), Op1Conv->getOperand(0), "mulconv");
396 return new SExtInst(NewMul, I.getType());
397 }
398 }
399 }
400
401 // Check for (mul (zext x), y), see if we can merge this into an
402 // integer mul followed by a zext.
403 if (auto *Op0Conv = dyn_cast<ZExtInst>(Op0)) {
404 // (mul (zext x), cst) --> (zext (mul x, cst'))
405 if (ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
406 if (Op0Conv->hasOneUse()) {
407 Constant *CI =
408 ConstantExpr::getTrunc(Op1C, Op0Conv->getOperand(0)->getType());
409 if (ConstantExpr::getZExt(CI, I.getType()) == Op1C &&
Craig Topperbb973722017-05-15 02:44:08 +0000410 willNotOverflowUnsignedMul(Op0Conv->getOperand(0), CI, I)) {
David Majnemera1cfd7c2016-12-30 00:28:58 +0000411 // Insert the new, smaller mul.
412 Value *NewMul =
Craig Topperbb4069e2017-07-07 23:16:26 +0000413 Builder.CreateNUWMul(Op0Conv->getOperand(0), CI, "mulconv");
David Majnemera1cfd7c2016-12-30 00:28:58 +0000414 return new ZExtInst(NewMul, I.getType());
415 }
416 }
417 }
418
419 // (mul (zext x), (zext y)) --> (zext (mul int x, y))
420 if (auto *Op1Conv = dyn_cast<ZExtInst>(Op1)) {
421 // Only do this if x/y have the same type, if at last one of them has a
422 // single use (so we don't increase the number of zexts), and if the
423 // integer mul will not overflow.
424 if (Op0Conv->getOperand(0)->getType() ==
425 Op1Conv->getOperand(0)->getType() &&
426 (Op0Conv->hasOneUse() || Op1Conv->hasOneUse()) &&
Craig Topperbb973722017-05-15 02:44:08 +0000427 willNotOverflowUnsignedMul(Op0Conv->getOperand(0),
428 Op1Conv->getOperand(0), I)) {
David Majnemera1cfd7c2016-12-30 00:28:58 +0000429 // Insert the new integer mul.
Craig Topperbb4069e2017-07-07 23:16:26 +0000430 Value *NewMul = Builder.CreateNUWMul(
David Majnemera1cfd7c2016-12-30 00:28:58 +0000431 Op0Conv->getOperand(0), Op1Conv->getOperand(0), "mulconv");
432 return new ZExtInst(NewMul, I.getType());
433 }
434 }
435 }
436
Craig Topper2b1fc322017-05-22 06:25:31 +0000437 if (!I.hasNoSignedWrap() && willNotOverflowSignedMul(Op0, Op1, I)) {
David Majnemer54c2ca22014-12-26 09:10:14 +0000438 Changed = true;
439 I.setHasNoSignedWrap(true);
440 }
441
Craig Topperbb973722017-05-15 02:44:08 +0000442 if (!I.hasNoUnsignedWrap() && willNotOverflowUnsignedMul(Op0, Op1, I)) {
David Majnemerb1296ec2014-12-26 09:50:35 +0000443 Changed = true;
444 I.setHasNoUnsignedWrap(true);
445 }
446
Craig Topperf40110f2014-04-25 05:29:35 +0000447 return Changed ? &I : nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000448}
449
Sanjay Patel5df4d882018-02-14 17:16:33 +0000450/// Helper function of InstCombiner::visitFMul(). Return true iff the given
451/// value is FMul or FDiv with one and only one operand being a finite-non-zero
452/// constant (i.e. not Zero/NaN/Infinity).
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000453static bool isFMulOrFDivWithConstant(Value *V) {
Sanjay Patel5df4d882018-02-14 17:16:33 +0000454 Constant *C;
455 return (match(V, m_FMul(m_Value(), m_Constant(C))) ||
456 match(V, m_FDiv(m_Value(), m_Constant(C))) ||
Sanjay Patel08868e4942018-02-16 22:32:54 +0000457 match(V, m_FDiv(m_Constant(C), m_Value()))) && C->isFiniteNonZeroFP();
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000458}
459
460/// foldFMulConst() is a helper routine of InstCombiner::visitFMul().
461/// The input \p FMulOrDiv is a FMul/FDiv with one and only one operand
462/// being a constant (i.e. isFMulOrFDivWithConstant(FMulOrDiv) == true).
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000463/// This function is to simplify "FMulOrDiv * C" and returns the
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000464/// resulting expression. Note that this function could return NULL in
465/// case the constants cannot be folded into a normal floating-point.
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000466Value *InstCombiner::foldFMulConst(Instruction *FMulOrDiv, Constant *C,
Shuxin Yang80138662013-01-07 22:41:28 +0000467 Instruction *InsertBefore) {
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000468 assert(isFMulOrFDivWithConstant(FMulOrDiv) && "V is invalid");
469
470 Value *Opnd0 = FMulOrDiv->getOperand(0);
471 Value *Opnd1 = FMulOrDiv->getOperand(1);
472
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000473 Constant *C0 = dyn_cast<Constant>(Opnd0);
474 Constant *C1 = dyn_cast<Constant>(Opnd1);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000475
Craig Topperf40110f2014-04-25 05:29:35 +0000476 BinaryOperator *R = nullptr;
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000477
478 // (X * C0) * C => X * (C0*C)
479 if (FMulOrDiv->getOpcode() == Instruction::FMul) {
480 Constant *F = ConstantExpr::getFMul(C1 ? C1 : C0, C);
Sanjay Patel08868e4942018-02-16 22:32:54 +0000481 if (F->isNormalFP())
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000482 R = BinaryOperator::CreateFMul(C1 ? Opnd0 : Opnd1, F);
483 } else {
484 if (C0) {
485 // (C0 / X) * C => (C0 * C) / X
Shuxin Yang3a7ca6e2013-09-19 21:13:46 +0000486 if (FMulOrDiv->hasOneUse()) {
487 // It would otherwise introduce another div.
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000488 Constant *F = ConstantExpr::getFMul(C0, C);
Sanjay Patel08868e4942018-02-16 22:32:54 +0000489 if (F->isNormalFP())
Shuxin Yang3a7ca6e2013-09-19 21:13:46 +0000490 R = BinaryOperator::CreateFDiv(F, Opnd1);
491 }
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000492 } else {
493 // (X / C1) * C => X * (C/C1) if C/C1 is not a denormal
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000494 Constant *F = ConstantExpr::getFDiv(C, C1);
Sanjay Patel08868e4942018-02-16 22:32:54 +0000495 if (F->isNormalFP()) {
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000496 R = BinaryOperator::CreateFMul(Opnd0, F);
497 } else {
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000498 // (X / C1) * C => X / (C1/C)
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000499 Constant *F = ConstantExpr::getFDiv(C1, C);
Sanjay Patel08868e4942018-02-16 22:32:54 +0000500 if (F->isNormalFP())
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000501 R = BinaryOperator::CreateFDiv(Opnd0, F);
502 }
503 }
504 }
505
506 if (R) {
Sanjay Patel629c4112017-11-06 16:27:15 +0000507 R->setFast(true);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000508 InsertNewInstWith(R, *InsertBefore);
509 }
510
511 return R;
512}
513
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000514Instruction *InstCombiner::visitFMul(BinaryOperator &I) {
Duncan Sands641baf12010-11-13 15:10:37 +0000515 bool Changed = SimplifyAssociativeOrCommutative(I);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000516 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
517
Serge Pavlov9ef66a82014-05-11 08:46:12 +0000518 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +0000519 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +0000520
Craig Toppera4205622017-06-09 03:21:29 +0000521 if (Value *V = SimplifyFMulInst(Op0, Op1, I.getFastMathFlags(),
522 SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +0000523 return replaceInstUsesWith(I, V);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000524
Sanjay Patel629c4112017-11-06 16:27:15 +0000525 bool AllowReassociate = I.isFast();
Shuxin Yange8227452013-01-15 21:09:32 +0000526
Sanjay Patel8fdd87f2018-02-28 16:36:24 +0000527 if (Instruction *FoldedMul = foldBinOpIntoSelectOrPhi(I))
528 return FoldedMul;
529
Michael Ilsemand5787be2012-12-12 00:28:32 +0000530 // Simplify mul instructions with a constant RHS.
Sanjay Patel58dab852018-02-14 16:56:44 +0000531 if (auto *C = dyn_cast<Constant>(Op1)) {
Sanjay Patel6b9c7a92018-02-23 17:14:28 +0000532 // -X * C --> X * -C
533 Value *X;
534 if (match(Op0, m_FNeg(m_Value(X))))
535 return BinaryOperator::CreateFMulFMF(X, ConstantExpr::getFNeg(C), &I);
536
Sanjay Pateleaf5a122018-02-28 22:30:04 +0000537 // X * -1.0 --> -X
538 if (match(C, m_SpecificFP(-1.0)))
539 return BinaryOperator::CreateFNegFMF(Op0, &I);
Owen Andersonf74cfe02014-01-16 20:36:42 +0000540
Sanjay Patel08868e4942018-02-16 22:32:54 +0000541 if (AllowReassociate && C->isFiniteNonZeroFP()) {
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000542 // Let MDC denote an expression in one of these forms:
543 // X * C, C/X, X/C, where C is a constant.
544 //
545 // Try to simplify "MDC * Constant"
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000546 if (isFMulOrFDivWithConstant(Op0))
547 if (Value *V = foldFMulConst(cast<Instruction>(Op0), C, &I))
Sanjay Patel4b198802016-02-01 22:23:39 +0000548 return replaceInstUsesWith(I, V);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000549
Quentin Colombete684a6d2013-02-28 21:12:40 +0000550 // (MDC +/- C1) * C => (MDC * C) +/- (C1 * C)
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000551 Instruction *FAddSub = dyn_cast<Instruction>(Op0);
552 if (FAddSub &&
553 (FAddSub->getOpcode() == Instruction::FAdd ||
554 FAddSub->getOpcode() == Instruction::FSub)) {
555 Value *Opnd0 = FAddSub->getOperand(0);
556 Value *Opnd1 = FAddSub->getOperand(1);
Benjamin Kramer76b15d02014-01-19 13:36:27 +0000557 Constant *C0 = dyn_cast<Constant>(Opnd0);
558 Constant *C1 = dyn_cast<Constant>(Opnd1);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000559 bool Swap = false;
560 if (C0) {
Shuxin Yang80138662013-01-07 22:41:28 +0000561 std::swap(C0, C1);
562 std::swap(Opnd0, Opnd1);
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000563 Swap = true;
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000564 }
565
Sanjay Patel08868e4942018-02-16 22:32:54 +0000566 if (C1 && C1->isFiniteNonZeroFP() && isFMulOrFDivWithConstant(Opnd0)) {
Quentin Colombete684a6d2013-02-28 21:12:40 +0000567 Value *M1 = ConstantExpr::getFMul(C1, C);
Sanjay Patel08868e4942018-02-16 22:32:54 +0000568 Value *M0 = cast<Constant>(M1)->isNormalFP() ?
569 foldFMulConst(cast<Instruction>(Opnd0), C, &I) :
570 nullptr;
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000571 if (M0 && M1) {
572 if (Swap && FAddSub->getOpcode() == Instruction::FSub)
573 std::swap(M0, M1);
574
Benjamin Kramer67485762013-09-30 15:39:59 +0000575 Instruction *RI = (FAddSub->getOpcode() == Instruction::FAdd)
576 ? BinaryOperator::CreateFAdd(M0, M1)
577 : BinaryOperator::CreateFSub(M0, M1);
Shuxin Yange8227452013-01-15 21:09:32 +0000578 RI->copyFastMathFlags(&I);
Shuxin Yangdf0e61e2013-01-07 21:39:23 +0000579 return RI;
580 }
581 }
582 }
583 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000584 }
585
Sanjay Patel2db27692018-02-23 22:38:10 +0000586 // fabs(X) * fabs(X) -> X * X
587 Value *X, *Y;
588 if (Op0 == Op1 && match(Op0, m_Intrinsic<Intrinsic::fabs>(m_Value(X))))
589 return BinaryOperator::CreateFMulFMF(X, X, &I);
Matt Arsenault56c079f2016-01-30 05:02:00 +0000590
Sanjay Patel2fd0acf2018-03-02 20:32:46 +0000591 // log2(X * 0.5) * Y = log2(X) * Y - Y
592 if (I.isFast()) {
593 IntrinsicInst *Log2 = nullptr;
594 if (match(Op0, m_OneUse(m_Intrinsic<Intrinsic::log2>(
595 m_OneUse(m_FMul(m_Value(X), m_SpecificFP(0.5))))))) {
596 Log2 = cast<IntrinsicInst>(Op0);
597 Y = Op1;
Pedro Artigasd8795042012-11-30 19:09:41 +0000598 }
Sanjay Patel2fd0acf2018-03-02 20:32:46 +0000599 if (match(Op1, m_OneUse(m_Intrinsic<Intrinsic::log2>(
600 m_OneUse(m_FMul(m_Value(X), m_SpecificFP(0.5))))))) {
601 Log2 = cast<IntrinsicInst>(Op1);
602 Y = Op0;
603 }
604 if (Log2) {
605 Log2->setArgOperand(0, X);
606 Log2->copyFastMathFlags(&I);
607 Value *LogXTimesY = Builder.CreateFMulFMF(Log2, Y, &I);
608 return BinaryOperator::CreateFSubFMF(LogXTimesY, Y, &I);
Pedro Artigasd8795042012-11-30 19:09:41 +0000609 }
610 }
611
Sanjay Pateld32104e2018-02-23 21:16:12 +0000612 // sqrt(X) * sqrt(Y) -> sqrt(X * Y)
Sanjay Pateld32104e2018-02-23 21:16:12 +0000613 if (I.hasAllowReassoc() &&
614 match(Op0, m_OneUse(m_Intrinsic<Intrinsic::sqrt>(m_Value(X)))) &&
615 match(Op1, m_OneUse(m_Intrinsic<Intrinsic::sqrt>(m_Value(Y))))) {
616 Value *XY = Builder.CreateFMulFMF(X, Y, &I);
617 Value *Sqrt = Builder.CreateIntrinsic(Intrinsic::sqrt, { XY }, &I);
618 return replaceInstUsesWith(I, Sqrt);
Dmitry Venikova58d8de2018-01-02 05:58:11 +0000619 }
620
Sanjay Patel6b9c7a92018-02-23 17:14:28 +0000621 // -X * -Y --> X * Y
Sanjay Patel6b9c7a92018-02-23 17:14:28 +0000622 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
623 return BinaryOperator::CreateFMulFMF(X, Y, &I);
624
625 // Sink negation: -X * Y --> -(X * Y)
626 if (match(Op0, m_OneUse(m_FNeg(m_Value(X)))))
627 return BinaryOperator::CreateFNegFMF(Builder.CreateFMulFMF(X, Op1, &I), &I);
628
629 // Sink negation: Y * -X --> -(X * Y)
630 if (match(Op1, m_OneUse(m_FNeg(m_Value(X)))))
631 return BinaryOperator::CreateFNegFMF(Builder.CreateFMulFMF(X, Op0, &I), &I);
632
Sanjay Patelb3f4f622018-02-28 16:50:51 +0000633 // (select A, B, C) * (select A, D, E) --> select A, (B*D), (C*E)
634 if (Value *V = SimplifySelectsFeedingBinaryOp(I, Op0, Op1))
635 return replaceInstUsesWith(I, V);
636
Sanjay Patelf3b1af72018-03-01 15:50:26 +0000637 // (X*Y) * X => (X*X) * Y where Y != X
638 // The purpose is two-fold:
639 // 1) to form a power expression (of X).
640 // 2) potentially shorten the critical path: After transformation, the
641 // latency of the instruction Y is amortized by the expression of X*X,
642 // and therefore Y is in a "less critical" position compared to what it
643 // was before the transformation.
Sanjay Pateld0cdb2f2018-03-02 00:14:51 +0000644 if (I.hasAllowReassoc()) {
Sanjay Patelf3b1af72018-03-01 15:50:26 +0000645 if (match(Op0, m_OneUse(m_c_FMul(m_Specific(Op1), m_Value(Y)))) &&
646 Op1 != Y) {
647 Value *XX = Builder.CreateFMulFMF(Op1, Op1, &I);
648 return BinaryOperator::CreateFMulFMF(XX, Y, &I);
Shuxin Yange8227452013-01-15 21:09:32 +0000649 }
Sanjay Patelf3b1af72018-03-01 15:50:26 +0000650 if (match(Op1, m_OneUse(m_c_FMul(m_Specific(Op0), m_Value(Y)))) &&
651 Op0 != Y) {
652 Value *XX = Builder.CreateFMulFMF(Op0, Op0, &I);
653 return BinaryOperator::CreateFMulFMF(XX, Y, &I);
654 }
Shuxin Yangf8e9a5a2012-12-14 18:46:06 +0000655 }
656
Craig Topperf40110f2014-04-25 05:29:35 +0000657 return Changed ? &I : nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000658}
659
Sanjay Patelae2e3a42017-10-06 23:20:16 +0000660/// Fold a divide or remainder with a select instruction divisor when one of the
661/// select operands is zero. In that case, we can use the other select operand
662/// because div/rem by zero is undefined.
663bool InstCombiner::simplifyDivRemOfSelectWithZeroOp(BinaryOperator &I) {
664 SelectInst *SI = dyn_cast<SelectInst>(I.getOperand(1));
665 if (!SI)
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000666 return false;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000667
Sanjay Patelae2e3a42017-10-06 23:20:16 +0000668 int NonNullOperand;
669 if (match(SI->getTrueValue(), m_Zero()))
670 // div/rem X, (Cond ? 0 : Y) -> div/rem X, Y
671 NonNullOperand = 2;
672 else if (match(SI->getFalseValue(), m_Zero()))
673 // div/rem X, (Cond ? Y : 0) -> div/rem X, Y
674 NonNullOperand = 1;
675 else
676 return false;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000677
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000678 // Change the div/rem to use 'Y' instead of the select.
679 I.setOperand(1, SI->getOperand(NonNullOperand));
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000680
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000681 // Okay, we know we replace the operand of the div/rem with 'Y' with no
682 // problem. However, the select, or the condition of the select may have
683 // multiple uses. Based on our knowledge that the operand must be non-zero,
684 // propagate the known value for the select into other uses of it, and
685 // propagate a known value of the condition into its other users.
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000686
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000687 // If the select and condition only have a single use, don't bother with this,
688 // early exit.
Sanjay Patelae2e3a42017-10-06 23:20:16 +0000689 Value *SelectCond = SI->getCondition();
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000690 if (SI->use_empty() && SelectCond->hasOneUse())
691 return true;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000692
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000693 // Scan the current block backward, looking for other uses of SI.
Duncan P. N. Exon Smith9f8aaf22015-10-13 16:59:33 +0000694 BasicBlock::iterator BBI = I.getIterator(), BBFront = I.getParent()->begin();
Sanjay Patel72d339a2017-10-06 23:43:06 +0000695 Type *CondTy = SelectCond->getType();
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000696 while (BBI != BBFront) {
697 --BBI;
698 // If we found a call to a function, we can't assume it will return, so
699 // information from below it cannot be propagated above it.
700 if (isa<CallInst>(BBI) && !isa<IntrinsicInst>(BBI))
701 break;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000702
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000703 // Replace uses of the select or its condition with the known values.
704 for (Instruction::op_iterator I = BBI->op_begin(), E = BBI->op_end();
705 I != E; ++I) {
706 if (*I == SI) {
707 *I = SI->getOperand(NonNullOperand);
Duncan P. N. Exon Smith9f8aaf22015-10-13 16:59:33 +0000708 Worklist.Add(&*BBI);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000709 } else if (*I == SelectCond) {
Sanjay Patel72d339a2017-10-06 23:43:06 +0000710 *I = NonNullOperand == 1 ? ConstantInt::getTrue(CondTy)
711 : ConstantInt::getFalse(CondTy);
Duncan P. N. Exon Smith9f8aaf22015-10-13 16:59:33 +0000712 Worklist.Add(&*BBI);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000713 }
714 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000715
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000716 // If we past the instruction, quit looking for it.
717 if (&*BBI == SI)
Craig Topperf40110f2014-04-25 05:29:35 +0000718 SI = nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000719 if (&*BBI == SelectCond)
Craig Topperf40110f2014-04-25 05:29:35 +0000720 SelectCond = nullptr;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000721
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000722 // If we ran out of things to eliminate, break out of the loop.
Craig Topperf40110f2014-04-25 05:29:35 +0000723 if (!SelectCond && !SI)
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000724 break;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000725
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000726 }
727 return true;
728}
729
Sanjay Patel1998cc62018-02-12 18:38:35 +0000730/// True if the multiply can not be expressed in an int this size.
731static bool multiplyOverflows(const APInt &C1, const APInt &C2, APInt &Product,
732 bool IsSigned) {
733 bool Overflow;
734 Product = IsSigned ? C1.smul_ov(C2, Overflow) : C1.umul_ov(C2, Overflow);
735 return Overflow;
736}
737
738/// True if C2 is a multiple of C1. Quotient contains C2/C1.
739static bool isMultiple(const APInt &C1, const APInt &C2, APInt &Quotient,
740 bool IsSigned) {
741 assert(C1.getBitWidth() == C2.getBitWidth() && "Constant widths not equal");
742
743 // Bail if we will divide by zero.
744 if (C2.isNullValue())
745 return false;
746
747 // Bail if we would divide INT_MIN by -1.
748 if (IsSigned && C1.isMinSignedValue() && C2.isAllOnesValue())
749 return false;
750
751 APInt Remainder(C1.getBitWidth(), /*Val=*/0ULL, IsSigned);
752 if (IsSigned)
753 APInt::sdivrem(C1, C2, Quotient, Remainder);
754 else
755 APInt::udivrem(C1, C2, Quotient, Remainder);
756
757 return Remainder.isMinValue();
758}
759
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000760/// This function implements the transforms common to both integer division
761/// instructions (udiv and sdiv). It is called by the visitors to those integer
762/// division instructions.
763/// @brief Common integer divide transforms
764Instruction *InstCombiner::commonIDivTransforms(BinaryOperator &I) {
765 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Sanjay Patel9530f182018-01-21 16:14:51 +0000766 bool IsSigned = I.getOpcode() == Instruction::SDiv;
Sanjay Patel39059d22018-02-12 14:14:56 +0000767 Type *Ty = I.getType();
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000768
Chris Lattner7c99f192011-05-22 18:18:41 +0000769 // The RHS is known non-zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000770 if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I)) {
Chris Lattner7c99f192011-05-22 18:18:41 +0000771 I.setOperand(1, V);
772 return &I;
773 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000774
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000775 // Handle cases involving: [su]div X, (select Cond, Y, Z)
776 // This does not apply for fdiv.
Sanjay Patelae2e3a42017-10-06 23:20:16 +0000777 if (simplifyDivRemOfSelectWithZeroOp(I))
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000778 return &I;
779
Sanjay Patel1998cc62018-02-12 18:38:35 +0000780 const APInt *C2;
781 if (match(Op1, m_APInt(C2))) {
782 Value *X;
783 const APInt *C1;
David Majnemerf9a095d2014-08-16 08:55:06 +0000784
Sanjay Patel1998cc62018-02-12 18:38:35 +0000785 // (X / C1) / C2 -> X / (C1*C2)
786 if ((IsSigned && match(Op0, m_SDiv(m_Value(X), m_APInt(C1)))) ||
787 (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_APInt(C1))))) {
788 APInt Product(C1->getBitWidth(), /*Val=*/0ULL, IsSigned);
789 if (!multiplyOverflows(*C1, *C2, Product, IsSigned))
790 return BinaryOperator::Create(I.getOpcode(), X,
791 ConstantInt::get(Ty, Product));
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000792 }
Sanjay Patel1998cc62018-02-12 18:38:35 +0000793
794 if ((IsSigned && match(Op0, m_NSWMul(m_Value(X), m_APInt(C1)))) ||
795 (!IsSigned && match(Op0, m_NUWMul(m_Value(X), m_APInt(C1))))) {
796 APInt Quotient(C1->getBitWidth(), /*Val=*/0ULL, IsSigned);
797
798 // (X * C1) / C2 -> X / (C2 / C1) if C2 is a multiple of C1.
799 if (isMultiple(*C2, *C1, Quotient, IsSigned)) {
800 auto *NewDiv = BinaryOperator::Create(I.getOpcode(), X,
801 ConstantInt::get(Ty, Quotient));
802 NewDiv->setIsExact(I.isExact());
803 return NewDiv;
804 }
805
806 // (X * C1) / C2 -> X * (C1 / C2) if C1 is a multiple of C2.
807 if (isMultiple(*C1, *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 ((IsSigned && match(Op0, m_NSWShl(m_Value(X), m_APInt(C1))) &&
818 *C1 != C1->getBitWidth() - 1) ||
819 (!IsSigned && match(Op0, m_NUWShl(m_Value(X), m_APInt(C1))))) {
820 APInt Quotient(C1->getBitWidth(), /*Val=*/0ULL, IsSigned);
821 APInt C1Shifted = APInt::getOneBitSet(
822 C1->getBitWidth(), static_cast<unsigned>(C1->getLimitedValue()));
823
824 // (X << C1) / C2 -> X / (C2 >> C1) if C2 is a multiple of C1.
825 if (isMultiple(*C2, C1Shifted, Quotient, IsSigned)) {
826 auto *BO = BinaryOperator::Create(I.getOpcode(), X,
827 ConstantInt::get(Ty, Quotient));
828 BO->setIsExact(I.isExact());
829 return BO;
830 }
831
832 // (X << C1) / C2 -> X * (C2 >> C1) if C1 is a multiple of C2.
833 if (isMultiple(C1Shifted, *C2, Quotient, IsSigned)) {
834 auto *Mul = BinaryOperator::Create(Instruction::Mul, X,
835 ConstantInt::get(Ty, Quotient));
836 auto *OBO = cast<OverflowingBinaryOperator>(Op0);
837 Mul->setHasNoUnsignedWrap(!IsSigned && OBO->hasNoUnsignedWrap());
838 Mul->setHasNoSignedWrap(OBO->hasNoSignedWrap());
839 return Mul;
840 }
841 }
842
843 if (!C2->isNullValue()) // avoid X udiv 0
Sanjay Patel8fdd87f2018-02-28 16:36:24 +0000844 if (Instruction *FoldedDiv = foldBinOpIntoSelectOrPhi(I))
Sanjay Patel1998cc62018-02-12 18:38:35 +0000845 return FoldedDiv;
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000846 }
847
Craig Topper218a3592017-04-17 03:41:47 +0000848 if (match(Op0, m_One())) {
Sanjay Patel39059d22018-02-12 14:14:56 +0000849 assert(!Ty->isIntOrIntVectorTy(1) && "i1 divide not removed?");
850 if (IsSigned) {
Craig Topper218a3592017-04-17 03:41:47 +0000851 // If Op1 is 0 then it's undefined behaviour, if Op1 is 1 then the
852 // result is one, if Op1 is -1 then the result is minus one, otherwise
853 // it's zero.
Craig Topperbb4069e2017-07-07 23:16:26 +0000854 Value *Inc = Builder.CreateAdd(Op1, Op0);
Sanjay Patel39059d22018-02-12 14:14:56 +0000855 Value *Cmp = Builder.CreateICmpULT(Inc, ConstantInt::get(Ty, 3));
856 return SelectInst::Create(Cmp, Op1, ConstantInt::get(Ty, 0));
Craig Topper218a3592017-04-17 03:41:47 +0000857 } else {
858 // If Op1 is 0 then it's undefined behaviour. If Op1 is 1 then the
859 // result is one, otherwise it's zero.
Sanjay Patel39059d22018-02-12 14:14:56 +0000860 return new ZExtInst(Builder.CreateICmpEQ(Op1, Op0), Ty);
Nick Lewyckyf0cf8fa2014-05-14 03:03:05 +0000861 }
862 }
863
Benjamin Kramer57b3df52011-04-30 18:16:00 +0000864 // See if we can fold away this div instruction.
865 if (SimplifyDemandedInstructionBits(I))
866 return &I;
867
Duncan Sands771e82a2011-01-28 16:51:11 +0000868 // (X - (X rem Y)) / Y -> X / Y; usually originates as ((X / Y) * Y) / Y
Sanjay Patel9530f182018-01-21 16:14:51 +0000869 Value *X, *Z;
870 if (match(Op0, m_Sub(m_Value(X), m_Value(Z)))) // (X - Z) / Y; Y = Op1
871 if ((IsSigned && match(Z, m_SRem(m_Specific(X), m_Specific(Op1)))) ||
872 (!IsSigned && match(Z, m_URem(m_Specific(X), m_Specific(Op1)))))
Duncan Sands771e82a2011-01-28 16:51:11 +0000873 return BinaryOperator::Create(I.getOpcode(), X, Op1);
Sanjay Patel9530f182018-01-21 16:14:51 +0000874
875 // (X << Y) / X -> 1 << Y
876 Value *Y;
877 if (IsSigned && match(Op0, m_NSWShl(m_Specific(Op1), m_Value(Y))))
Sanjay Patel39059d22018-02-12 14:14:56 +0000878 return BinaryOperator::CreateNSWShl(ConstantInt::get(Ty, 1), Y);
Sanjay Patel9530f182018-01-21 16:14:51 +0000879 if (!IsSigned && match(Op0, m_NUWShl(m_Specific(Op1), m_Value(Y))))
Sanjay Patel39059d22018-02-12 14:14:56 +0000880 return BinaryOperator::CreateNUWShl(ConstantInt::get(Ty, 1), Y);
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000881
Sanjay Patel510d6472018-02-11 17:20:32 +0000882 // X / (X * Y) -> 1 / Y if the multiplication does not overflow.
883 if (match(Op1, m_c_Mul(m_Specific(Op0), m_Value(Y)))) {
884 bool HasNSW = cast<OverflowingBinaryOperator>(Op1)->hasNoSignedWrap();
885 bool HasNUW = cast<OverflowingBinaryOperator>(Op1)->hasNoUnsignedWrap();
886 if ((IsSigned && HasNSW) || (!IsSigned && HasNUW)) {
Sanjay Patel39059d22018-02-12 14:14:56 +0000887 I.setOperand(0, ConstantInt::get(Ty, 1));
Sanjay Patel510d6472018-02-11 17:20:32 +0000888 I.setOperand(1, Y);
889 return &I;
890 }
891 }
892
Craig Topperf40110f2014-04-25 05:29:35 +0000893 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +0000894}
895
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +0000896static const unsigned MaxDepth = 6;
897
David Majnemer37f8f442013-07-04 21:17:49 +0000898namespace {
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +0000899
900using FoldUDivOperandCb = Instruction *(*)(Value *Op0, Value *Op1,
901 const BinaryOperator &I,
902 InstCombiner &IC);
David Majnemer37f8f442013-07-04 21:17:49 +0000903
904/// \brief Used to maintain state for visitUDivOperand().
905struct UDivFoldAction {
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +0000906 /// Informs visitUDiv() how to fold this operand. This can be zero if this
907 /// action joins two actions together.
908 FoldUDivOperandCb FoldAction;
David Majnemer37f8f442013-07-04 21:17:49 +0000909
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +0000910 /// Which operand to fold.
911 Value *OperandToFold;
912
David Majnemer37f8f442013-07-04 21:17:49 +0000913 union {
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +0000914 /// The instruction returned when FoldAction is invoked.
915 Instruction *FoldResult;
David Majnemer37f8f442013-07-04 21:17:49 +0000916
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +0000917 /// Stores the LHS action index if this action joins two actions together.
918 size_t SelectLHSIdx;
David Majnemer37f8f442013-07-04 21:17:49 +0000919 };
920
921 UDivFoldAction(FoldUDivOperandCb FA, Value *InputOperand)
Craig Topperf40110f2014-04-25 05:29:35 +0000922 : FoldAction(FA), OperandToFold(InputOperand), FoldResult(nullptr) {}
David Majnemer37f8f442013-07-04 21:17:49 +0000923 UDivFoldAction(FoldUDivOperandCb FA, Value *InputOperand, size_t SLHS)
924 : FoldAction(FA), OperandToFold(InputOperand), SelectLHSIdx(SLHS) {}
925};
Eugene Zelenko7f0f9bc2017-10-24 21:24:53 +0000926
927} // end anonymous namespace
David Majnemer37f8f442013-07-04 21:17:49 +0000928
929// X udiv 2^C -> X >> C
930static Instruction *foldUDivPow2Cst(Value *Op0, Value *Op1,
931 const BinaryOperator &I, InstCombiner &IC) {
Simon Pilgrim94cc89d2018-02-08 14:46:10 +0000932 Constant *C1 = getLogBase2(Op0->getType(), cast<Constant>(Op1));
933 if (!C1)
934 llvm_unreachable("Failed to constant fold udiv -> logbase2");
935 BinaryOperator *LShr = BinaryOperator::CreateLShr(Op0, C1);
Suyog Sarda65f5ae92014-10-07 12:04:07 +0000936 if (I.isExact())
937 LShr->setIsExact();
David Majnemer37f8f442013-07-04 21:17:49 +0000938 return LShr;
939}
940
941// X udiv C, where C >= signbit
942static Instruction *foldUDivNegCst(Value *Op0, Value *Op1,
943 const BinaryOperator &I, InstCombiner &IC) {
Simon Pilgrim9620f4b2018-02-09 10:43:59 +0000944 Value *ICI = IC.Builder.CreateICmpULT(Op0, cast<Constant>(Op1));
David Majnemer37f8f442013-07-04 21:17:49 +0000945 return SelectInst::Create(ICI, Constant::getNullValue(I.getType()),
946 ConstantInt::get(I.getType(), 1));
947}
948
949// X udiv (C1 << N), where C1 is "1<<C2" --> X >> (N+C2)
Andrea Di Biagioa82d52d2016-09-26 12:07:23 +0000950// X udiv (zext (C1 << N)), where C1 is "1<<C2" --> X >> (N+C2)
David Majnemer37f8f442013-07-04 21:17:49 +0000951static Instruction *foldUDivShl(Value *Op0, Value *Op1, const BinaryOperator &I,
952 InstCombiner &IC) {
Andrea Di Biagioa82d52d2016-09-26 12:07:23 +0000953 Value *ShiftLeft;
954 if (!match(Op1, m_ZExt(m_Value(ShiftLeft))))
955 ShiftLeft = Op1;
David Majnemer37f8f442013-07-04 21:17:49 +0000956
Simon Pilgrim2a90acd2018-02-08 15:19:38 +0000957 Constant *CI;
Andrea Di Biagioa82d52d2016-09-26 12:07:23 +0000958 Value *N;
Simon Pilgrim2a90acd2018-02-08 15:19:38 +0000959 if (!match(ShiftLeft, m_Shl(m_Constant(CI), m_Value(N))))
Andrea Di Biagioa82d52d2016-09-26 12:07:23 +0000960 llvm_unreachable("match should never fail here!");
Simon Pilgrim2a90acd2018-02-08 15:19:38 +0000961 Constant *Log2Base = getLogBase2(N->getType(), CI);
962 if (!Log2Base)
963 llvm_unreachable("getLogBase2 should never fail here!");
964 N = IC.Builder.CreateAdd(N, Log2Base);
Andrea Di Biagioa82d52d2016-09-26 12:07:23 +0000965 if (Op1 != ShiftLeft)
Craig Topperbb4069e2017-07-07 23:16:26 +0000966 N = IC.Builder.CreateZExt(N, Op1->getType());
David Majnemer37f8f442013-07-04 21:17:49 +0000967 BinaryOperator *LShr = BinaryOperator::CreateLShr(Op0, N);
Suyog Sarda65f5ae92014-10-07 12:04:07 +0000968 if (I.isExact())
969 LShr->setIsExact();
David Majnemer37f8f442013-07-04 21:17:49 +0000970 return LShr;
971}
972
973// \brief Recursively visits the possible right hand operands of a udiv
974// instruction, seeing through select instructions, to determine if we can
975// replace the udiv with something simpler. If we find that an operand is not
976// able to simplify the udiv, we abort the entire transformation.
977static size_t visitUDivOperand(Value *Op0, Value *Op1, const BinaryOperator &I,
978 SmallVectorImpl<UDivFoldAction> &Actions,
979 unsigned Depth = 0) {
980 // Check to see if this is an unsigned division with an exact power of 2,
981 // if so, convert to a right shift.
982 if (match(Op1, m_Power2())) {
983 Actions.push_back(UDivFoldAction(foldUDivPow2Cst, Op1));
984 return Actions.size();
985 }
986
Simon Pilgrim9620f4b2018-02-09 10:43:59 +0000987 // X udiv C, where C >= signbit
988 if (match(Op1, m_Negative())) {
989 Actions.push_back(UDivFoldAction(foldUDivNegCst, Op1));
990 return Actions.size();
991 }
David Majnemer37f8f442013-07-04 21:17:49 +0000992
993 // X udiv (C1 << N), where C1 is "1<<C2" --> X >> (N+C2)
994 if (match(Op1, m_Shl(m_Power2(), m_Value())) ||
995 match(Op1, m_ZExt(m_Shl(m_Power2(), m_Value())))) {
996 Actions.push_back(UDivFoldAction(foldUDivShl, Op1));
997 return Actions.size();
998 }
999
1000 // The remaining tests are all recursive, so bail out if we hit the limit.
1001 if (Depth++ == MaxDepth)
1002 return 0;
1003
1004 if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
David Majnemer492e6122014-08-30 09:19:05 +00001005 if (size_t LHSIdx =
1006 visitUDivOperand(Op0, SI->getOperand(1), I, Actions, Depth))
1007 if (visitUDivOperand(Op0, SI->getOperand(2), I, Actions, Depth)) {
1008 Actions.push_back(UDivFoldAction(nullptr, Op1, LHSIdx - 1));
David Majnemer37f8f442013-07-04 21:17:49 +00001009 return Actions.size();
1010 }
1011
1012 return 0;
1013}
1014
Sanjay Patelbb789382017-08-24 22:54:01 +00001015/// If we have zero-extended operands of an unsigned div or rem, we may be able
1016/// to narrow the operation (sink the zext below the math).
1017static Instruction *narrowUDivURem(BinaryOperator &I,
1018 InstCombiner::BuilderTy &Builder) {
1019 Instruction::BinaryOps Opcode = I.getOpcode();
1020 Value *N = I.getOperand(0);
1021 Value *D = I.getOperand(1);
1022 Type *Ty = I.getType();
1023 Value *X, *Y;
1024 if (match(N, m_ZExt(m_Value(X))) && match(D, m_ZExt(m_Value(Y))) &&
1025 X->getType() == Y->getType() && (N->hasOneUse() || D->hasOneUse())) {
1026 // udiv (zext X), (zext Y) --> zext (udiv X, Y)
1027 // urem (zext X), (zext Y) --> zext (urem X, Y)
1028 Value *NarrowOp = Builder.CreateBinOp(Opcode, X, Y);
1029 return new ZExtInst(NarrowOp, Ty);
1030 }
1031
1032 Constant *C;
1033 if ((match(N, m_OneUse(m_ZExt(m_Value(X)))) && match(D, m_Constant(C))) ||
1034 (match(D, m_OneUse(m_ZExt(m_Value(X)))) && match(N, m_Constant(C)))) {
1035 // If the constant is the same in the smaller type, use the narrow version.
1036 Constant *TruncC = ConstantExpr::getTrunc(C, X->getType());
1037 if (ConstantExpr::getZExt(TruncC, Ty) != C)
1038 return nullptr;
1039
1040 // udiv (zext X), C --> zext (udiv X, C')
1041 // urem (zext X), C --> zext (urem X, C')
1042 // udiv C, (zext X) --> zext (udiv C', X)
1043 // urem C, (zext X) --> zext (urem C', X)
1044 Value *NarrowOp = isa<Constant>(D) ? Builder.CreateBinOp(Opcode, X, TruncC)
1045 : Builder.CreateBinOp(Opcode, TruncC, X);
1046 return new ZExtInst(NarrowOp, Ty);
1047 }
1048
1049 return nullptr;
1050}
1051
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001052Instruction *InstCombiner::visitUDiv(BinaryOperator &I) {
1053 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1054
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001055 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001056 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001057
Craig Toppera4205622017-06-09 03:21:29 +00001058 if (Value *V = SimplifyUDivInst(Op0, Op1, SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001059 return replaceInstUsesWith(I, V);
Duncan Sands771e82a2011-01-28 16:51:11 +00001060
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001061 // Handle the integer div common cases
1062 if (Instruction *Common = commonIDivTransforms(I))
1063 return Common;
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001064
Benjamin Kramerd4a64712012-08-30 15:07:40 +00001065 // (x lshr C1) udiv C2 --> x udiv (C2 << C1)
David Majnemera2521382014-10-13 21:48:30 +00001066 {
Benjamin Kramer9c0a8072012-08-28 13:08:13 +00001067 Value *X;
David Majnemera2521382014-10-13 21:48:30 +00001068 const APInt *C1, *C2;
1069 if (match(Op0, m_LShr(m_Value(X), m_APInt(C1))) &&
1070 match(Op1, m_APInt(C2))) {
1071 bool Overflow;
1072 APInt C2ShlC1 = C2->ushl_ov(*C1, Overflow);
David Majnemera3aeb152014-11-22 18:16:54 +00001073 if (!Overflow) {
1074 bool IsExact = I.isExact() && match(Op0, m_Exact(m_Value()));
1075 BinaryOperator *BO = BinaryOperator::CreateUDiv(
David Majnemera2521382014-10-13 21:48:30 +00001076 X, ConstantInt::get(X->getType(), C2ShlC1));
David Majnemera3aeb152014-11-22 18:16:54 +00001077 if (IsExact)
1078 BO->setIsExact();
1079 return BO;
1080 }
David Majnemera2521382014-10-13 21:48:30 +00001081 }
Nadav Rotem11935b22012-08-28 10:01:43 +00001082 }
1083
Sanjay Patelbb789382017-08-24 22:54:01 +00001084 if (Instruction *NarrowDiv = narrowUDivURem(I, Builder))
1085 return NarrowDiv;
Benjamin Kramer9aa91b12011-04-30 18:16:07 +00001086
David Majnemer37f8f442013-07-04 21:17:49 +00001087 // (LHS udiv (select (select (...)))) -> (LHS >> (select (select (...))))
1088 SmallVector<UDivFoldAction, 6> UDivActions;
1089 if (visitUDivOperand(Op0, Op1, I, UDivActions))
1090 for (unsigned i = 0, e = UDivActions.size(); i != e; ++i) {
1091 FoldUDivOperandCb Action = UDivActions[i].FoldAction;
1092 Value *ActionOp1 = UDivActions[i].OperandToFold;
1093 Instruction *Inst;
1094 if (Action)
1095 Inst = Action(Op0, ActionOp1, I, *this);
1096 else {
1097 // This action joins two actions together. The RHS of this action is
1098 // simply the last action we processed, we saved the LHS action index in
1099 // the joining action.
1100 size_t SelectRHSIdx = i - 1;
1101 Value *SelectRHS = UDivActions[SelectRHSIdx].FoldResult;
1102 size_t SelectLHSIdx = UDivActions[i].SelectLHSIdx;
1103 Value *SelectLHS = UDivActions[SelectLHSIdx].FoldResult;
1104 Inst = SelectInst::Create(cast<SelectInst>(ActionOp1)->getCondition(),
1105 SelectLHS, SelectRHS);
1106 }
1107
1108 // If this is the last action to process, return it to the InstCombiner.
1109 // Otherwise, we insert it before the UDiv and record it so that we may
1110 // use it as part of a joining action (i.e., a SelectInst).
1111 if (e - i != 1) {
1112 Inst->insertBefore(&I);
1113 UDivActions[i].FoldResult = Inst;
1114 } else
1115 return Inst;
1116 }
1117
Craig Topperf40110f2014-04-25 05:29:35 +00001118 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001119}
1120
1121Instruction *InstCombiner::visitSDiv(BinaryOperator &I) {
1122 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1123
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001124 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001125 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001126
Craig Toppera4205622017-06-09 03:21:29 +00001127 if (Value *V = SimplifySDivInst(Op0, Op1, SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001128 return replaceInstUsesWith(I, V);
Duncan Sands771e82a2011-01-28 16:51:11 +00001129
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001130 // Handle the integer div common cases
1131 if (Instruction *Common = commonIDivTransforms(I))
1132 return Common;
1133
Sanjay Patelc6ada532016-06-27 17:25:57 +00001134 const APInt *Op1C;
Sanjay Patelbedd1f92016-06-27 18:38:40 +00001135 if (match(Op1, m_APInt(Op1C))) {
1136 // sdiv X, -1 == -X
1137 if (Op1C->isAllOnesValue())
1138 return BinaryOperator::CreateNeg(Op0);
1139
1140 // sdiv exact X, C --> ashr exact X, log2(C)
1141 if (I.isExact() && Op1C->isNonNegative() && Op1C->isPowerOf2()) {
1142 Value *ShAmt = ConstantInt::get(Op1->getType(), Op1C->exactLogBase2());
1143 return BinaryOperator::CreateExactAShr(Op0, ShAmt, I.getName());
1144 }
Sanjay Patel59ed2ff2016-06-27 22:27:11 +00001145
1146 // If the dividend is sign-extended and the constant divisor is small enough
1147 // to fit in the source type, shrink the division to the narrower type:
1148 // (sext X) sdiv C --> sext (X sdiv C)
1149 Value *Op0Src;
1150 if (match(Op0, m_OneUse(m_SExt(m_Value(Op0Src)))) &&
1151 Op0Src->getType()->getScalarSizeInBits() >= Op1C->getMinSignedBits()) {
1152
1153 // In the general case, we need to make sure that the dividend is not the
1154 // minimum signed value because dividing that by -1 is UB. But here, we
1155 // know that the -1 divisor case is already handled above.
1156
1157 Constant *NarrowDivisor =
1158 ConstantExpr::getTrunc(cast<Constant>(Op1), Op0Src->getType());
Craig Topperbb4069e2017-07-07 23:16:26 +00001159 Value *NarrowOp = Builder.CreateSDiv(Op0Src, NarrowDivisor);
Sanjay Patel59ed2ff2016-06-27 22:27:11 +00001160 return new SExtInst(NarrowOp, Op0->getType());
1161 }
Benjamin Kramer72196f32014-01-19 15:24:22 +00001162 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001163
Benjamin Kramer72196f32014-01-19 15:24:22 +00001164 if (Constant *RHS = dyn_cast<Constant>(Op1)) {
David Majnemerf28e2a42014-07-02 06:42:13 +00001165 // X/INT_MIN -> X == INT_MIN
1166 if (RHS->isMinSignedValue())
Craig Topperbb4069e2017-07-07 23:16:26 +00001167 return new ZExtInst(Builder.CreateICmpEQ(Op0, Op1), I.getType());
David Majnemerf28e2a42014-07-02 06:42:13 +00001168
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001169 // -X/C --> X/-C provided the negation doesn't overflow.
David Majnemerfa4699e2014-11-22 20:00:34 +00001170 Value *X;
1171 if (match(Op0, m_NSWSub(m_Zero(), m_Value(X)))) {
1172 auto *BO = BinaryOperator::CreateSDiv(X, ConstantExpr::getNeg(RHS));
1173 BO->setIsExact(I.isExact());
1174 return BO;
1175 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001176 }
1177
1178 // If the sign bits of both operands are zero (i.e. we can prove they are
1179 // unsigned inputs), turn this into a udiv.
Craig Topperbcfd2d12017-04-20 16:56:25 +00001180 APInt Mask(APInt::getSignMask(I.getType()->getScalarSizeInBits()));
Craig Topperf2484682017-04-17 01:51:19 +00001181 if (MaskedValueIsZero(Op0, Mask, 0, &I)) {
1182 if (MaskedValueIsZero(Op1, Mask, 0, &I)) {
1183 // X sdiv Y -> X udiv Y, iff X and Y don't have sign bit set
1184 auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
1185 BO->setIsExact(I.isExact());
1186 return BO;
1187 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001188
Craig Topperd4039f72017-05-25 21:51:12 +00001189 if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/ true, 0, &I)) {
Craig Topperf2484682017-04-17 01:51:19 +00001190 // X sdiv (1 << Y) -> X udiv (1 << Y) ( -> X u>> Y)
1191 // Safe because the only negative value (1 << Y) can take on is
1192 // INT_MIN, and X sdiv INT_MIN == X udiv INT_MIN == 0 if X doesn't have
1193 // the sign bit set.
1194 auto *BO = BinaryOperator::CreateUDiv(Op0, Op1, I.getName());
1195 BO->setIsExact(I.isExact());
1196 return BO;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001197 }
1198 }
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001199
Craig Topperf40110f2014-04-25 05:29:35 +00001200 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001201}
1202
Sanjay Pateld8dd0152018-02-20 23:51:16 +00001203/// Remove negation and try to convert division into multiplication.
Sanjay Patel90f4c8e2018-02-20 16:08:15 +00001204static Instruction *foldFDivConstantDivisor(BinaryOperator &I) {
1205 Constant *C;
1206 if (!match(I.getOperand(1), m_Constant(C)))
Craig Topperf40110f2014-04-25 05:29:35 +00001207 return nullptr;
Benjamin Kramer76b15d02014-01-19 13:36:27 +00001208
Sanjay Pateld8dd0152018-02-20 23:51:16 +00001209 // -X / C --> X / -C
1210 Value *X;
1211 if (match(I.getOperand(0), m_FNeg(m_Value(X))))
Sanjay Patel5a6f9042018-02-21 22:18:55 +00001212 return BinaryOperator::CreateFDivFMF(X, ConstantExpr::getFNeg(C), &I);
Sanjay Pateld8dd0152018-02-20 23:51:16 +00001213
Sanjay Patel90f4c8e2018-02-20 16:08:15 +00001214 // If the constant divisor has an exact inverse, this is always safe. If not,
1215 // then we can still create a reciprocal if fast-math-flags allow it and the
1216 // constant is a regular number (not zero, infinite, or denormal).
1217 if (!(C->hasExactInverseFP() || (I.hasAllowReciprocal() && C->isNormalFP())))
Craig Topperf40110f2014-04-25 05:29:35 +00001218 return nullptr;
Shuxin Yang320f52a2013-01-14 22:48:41 +00001219
Sanjay Patel90f4c8e2018-02-20 16:08:15 +00001220 // Disallow denormal constants because we don't know what would happen
1221 // on all targets.
1222 // TODO: Use Intrinsic::canonicalize or let function attributes tell us that
1223 // denorms are flushed?
1224 auto *RecipC = ConstantExpr::getFDiv(ConstantFP::get(I.getType(), 1.0), C);
1225 if (!RecipC->isNormalFP())
1226 return nullptr;
1227
Sanjay Pateld8dd0152018-02-20 23:51:16 +00001228 // X / C --> X * (1 / C)
Sanjay Patel5a6f9042018-02-21 22:18:55 +00001229 return BinaryOperator::CreateFMulFMF(I.getOperand(0), RecipC, &I);
Shuxin Yang320f52a2013-01-14 22:48:41 +00001230}
1231
Sanjay Patel6f716a72018-02-21 00:01:45 +00001232/// Remove negation and try to reassociate constant math.
Sanjay Patele4129542018-02-19 21:17:58 +00001233static Instruction *foldFDivConstantDividend(BinaryOperator &I) {
Sanjay Patel6f716a72018-02-21 00:01:45 +00001234 Constant *C;
1235 if (!match(I.getOperand(0), m_Constant(C)))
Sanjay Patele4129542018-02-19 21:17:58 +00001236 return nullptr;
1237
Sanjay Patel6f716a72018-02-21 00:01:45 +00001238 // C / -X --> -C / X
Sanjay Patele4129542018-02-19 21:17:58 +00001239 Value *X;
Sanjay Patel5a6f9042018-02-21 22:18:55 +00001240 if (match(I.getOperand(1), m_FNeg(m_Value(X))))
1241 return BinaryOperator::CreateFDivFMF(ConstantExpr::getFNeg(C), X, &I);
Sanjay Patel6f716a72018-02-21 00:01:45 +00001242
1243 if (!I.hasAllowReassoc() || !I.hasAllowReciprocal())
1244 return nullptr;
1245
1246 // Try to reassociate C / X expressions where X includes another constant.
Sanjay Patele4129542018-02-19 21:17:58 +00001247 Constant *C2, *NewC = nullptr;
1248 if (match(I.getOperand(1), m_FMul(m_Value(X), m_Constant(C2)))) {
Sanjay Patel6f716a72018-02-21 00:01:45 +00001249 // C / (X * C2) --> (C / C2) / X
1250 NewC = ConstantExpr::getFDiv(C, C2);
Sanjay Patele4129542018-02-19 21:17:58 +00001251 } else if (match(I.getOperand(1), m_FDiv(m_Value(X), m_Constant(C2)))) {
Sanjay Patel6f716a72018-02-21 00:01:45 +00001252 // C / (X / C2) --> (C * C2) / X
1253 NewC = ConstantExpr::getFMul(C, C2);
Sanjay Patele4129542018-02-19 21:17:58 +00001254 }
1255 // Disallow denormal constants because we don't know what would happen
1256 // on all targets.
1257 // TODO: Use Intrinsic::canonicalize or let function attributes tell us that
1258 // denorms are flushed?
1259 if (!NewC || !NewC->isNormalFP())
1260 return nullptr;
1261
Sanjay Patel5a6f9042018-02-21 22:18:55 +00001262 return BinaryOperator::CreateFDivFMF(NewC, X, &I);
Sanjay Patele4129542018-02-19 21:17:58 +00001263}
1264
Frits van Bommel2a559512011-01-29 17:50:27 +00001265Instruction *InstCombiner::visitFDiv(BinaryOperator &I) {
1266 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1267
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001268 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001269 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001270
Craig Toppera4205622017-06-09 03:21:29 +00001271 if (Value *V = SimplifyFDivInst(Op0, Op1, I.getFastMathFlags(),
1272 SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001273 return replaceInstUsesWith(I, V);
Frits van Bommel2a559512011-01-29 17:50:27 +00001274
Sanjay Pateld8dd0152018-02-20 23:51:16 +00001275 if (Instruction *R = foldFDivConstantDivisor(I))
1276 return R;
Sanjay Patel28165602018-02-19 23:09:03 +00001277
Sanjay Pateld8dd0152018-02-20 23:51:16 +00001278 if (Instruction *R = foldFDivConstantDividend(I))
1279 return R;
Sanjay Patelb39bcc02018-02-14 23:04:17 +00001280
Stephen Lina9b57f62013-07-20 07:13:13 +00001281 if (isa<Constant>(Op0))
1282 if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
1283 if (Instruction *R = FoldOpIntoSelect(I, SI))
1284 return R;
1285
Sanjay Patel29b98ae2018-02-20 17:14:53 +00001286 if (isa<Constant>(Op1))
Stephen Lina9b57f62013-07-20 07:13:13 +00001287 if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
1288 if (Instruction *R = FoldOpIntoSelect(I, SI))
1289 return R;
Shuxin Yang320f52a2013-01-14 22:48:41 +00001290
Sanjay Patel31a90462018-02-26 16:02:45 +00001291 if (I.hasAllowReassoc() && I.hasAllowReciprocal()) {
Shuxin Yang320f52a2013-01-14 22:48:41 +00001292 Value *X, *Y;
Sanjay Patel91bb7752018-02-16 17:52:32 +00001293 if (match(Op0, m_OneUse(m_FDiv(m_Value(X), m_Value(Y)))) &&
1294 (!isa<Constant>(Y) || !isa<Constant>(Op1))) {
1295 // (X / Y) / Z => X / (Y * Z)
Sanjay Patel31a90462018-02-26 16:02:45 +00001296 Value *YZ = Builder.CreateFMulFMF(Y, Op1, &I);
Sanjay Patel5a6f9042018-02-21 22:18:55 +00001297 return BinaryOperator::CreateFDivFMF(X, YZ, &I);
Shuxin Yang320f52a2013-01-14 22:48:41 +00001298 }
Sanjay Patel91bb7752018-02-16 17:52:32 +00001299 if (match(Op1, m_OneUse(m_FDiv(m_Value(X), m_Value(Y)))) &&
1300 (!isa<Constant>(Y) || !isa<Constant>(Op0))) {
1301 // Z / (X / Y) => (Y * Z) / X
Sanjay Patel31a90462018-02-26 16:02:45 +00001302 Value *YZ = Builder.CreateFMulFMF(Y, Op0, &I);
Sanjay Patel5a6f9042018-02-21 22:18:55 +00001303 return BinaryOperator::CreateFDivFMF(YZ, X, &I);
Benjamin Kramer8564e0d2011-03-30 15:42:35 +00001304 }
1305 }
1306
Sanjay Patel339b4d32018-02-15 15:07:12 +00001307 if (I.hasAllowReassoc() && Op0->hasOneUse() && Op1->hasOneUse()) {
Sanjay Patel65da14d2018-02-16 16:13:20 +00001308 // sin(X) / cos(X) -> tan(X)
1309 // cos(X) / sin(X) -> 1/tan(X) (cotangent)
1310 Value *X;
1311 bool IsTan = match(Op0, m_Intrinsic<Intrinsic::sin>(m_Value(X))) &&
1312 match(Op1, m_Intrinsic<Intrinsic::cos>(m_Specific(X)));
1313 bool IsCot =
1314 !IsTan && match(Op0, m_Intrinsic<Intrinsic::cos>(m_Value(X))) &&
1315 match(Op1, m_Intrinsic<Intrinsic::sin>(m_Specific(X)));
Dmitry Venikove5fbf592018-01-11 06:33:00 +00001316
Sanjay Patel65da14d2018-02-16 16:13:20 +00001317 if ((IsTan || IsCot) && hasUnaryFloatFn(&TLI, I.getType(), LibFunc_tan,
1318 LibFunc_tanf, LibFunc_tanl)) {
1319 IRBuilder<> B(&I);
1320 IRBuilder<>::FastMathFlagGuard FMFGuard(B);
1321 B.setFastMathFlags(I.getFastMathFlags());
1322 AttributeList Attrs = CallSite(Op0).getCalledFunction()->getAttributes();
1323 Value *Res = emitUnaryFloatFnCall(X, TLI.getName(LibFunc_tan), B, Attrs);
1324 if (IsCot)
1325 Res = B.CreateFDiv(ConstantFP::get(I.getType(), 1.0), Res);
1326 return replaceInstUsesWith(I, Res);
Dmitry Venikove5fbf592018-01-11 06:33:00 +00001327 }
1328 }
1329
Sanjay Patel1998cc62018-02-12 18:38:35 +00001330 // -X / -Y -> X / Y
1331 Value *X, *Y;
1332 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y)))) {
1333 I.setOperand(0, X);
1334 I.setOperand(1, Y);
Matt Arsenaultfdb78f82017-01-10 23:08:54 +00001335 return &I;
1336 }
1337
Sanjay Patel4a4f35f2018-02-12 19:39:21 +00001338 // X / (X * Y) --> 1.0 / Y
1339 // Reassociate to (X / X -> 1.0) is legal when NaNs are not allowed.
1340 // We can ignore the possibility that X is infinity because INF/INF is NaN.
1341 if (I.hasNoNaNs() && I.hasAllowReassoc() &&
1342 match(Op1, m_c_FMul(m_Specific(Op0), m_Value(Y)))) {
1343 I.setOperand(0, ConstantFP::get(I.getType(), 1.0));
1344 I.setOperand(1, Y);
1345 return &I;
1346 }
1347
Craig Topperf40110f2014-04-25 05:29:35 +00001348 return nullptr;
Frits van Bommel2a559512011-01-29 17:50:27 +00001349}
1350
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001351/// This function implements the transforms common to both integer remainder
1352/// instructions (urem and srem). It is called by the visitors to those integer
1353/// remainder instructions.
1354/// @brief Common integer remainder transforms
1355Instruction *InstCombiner::commonIRemTransforms(BinaryOperator &I) {
1356 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1357
Chris Lattner7c99f192011-05-22 18:18:41 +00001358 // The RHS is known non-zero.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001359 if (Value *V = simplifyValueKnownNonZero(I.getOperand(1), *this, I)) {
Chris Lattner7c99f192011-05-22 18:18:41 +00001360 I.setOperand(1, V);
1361 return &I;
1362 }
1363
Duncan Sandsa3e36992011-05-02 16:27:02 +00001364 // Handle cases involving: rem X, (select Cond, Y, Z)
Sanjay Patelae2e3a42017-10-06 23:20:16 +00001365 if (simplifyDivRemOfSelectWithZeroOp(I))
Duncan Sandsa3e36992011-05-02 16:27:02 +00001366 return &I;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001367
Benjamin Kramer72196f32014-01-19 15:24:22 +00001368 if (isa<Constant>(Op1)) {
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001369 if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
1370 if (SelectInst *SI = dyn_cast<SelectInst>(Op0I)) {
1371 if (Instruction *R = FoldOpIntoSelect(I, SI))
1372 return R;
Craig Topperfb71b7d2017-04-14 19:20:12 +00001373 } else if (auto *PN = dyn_cast<PHINode>(Op0I)) {
Sanjoy Dasb7e861a2016-06-05 21:17:04 +00001374 const APInt *Op1Int;
1375 if (match(Op1, m_APInt(Op1Int)) && !Op1Int->isMinValue() &&
1376 (I.getOpcode() == Instruction::URem ||
1377 !Op1Int->isMinSignedValue())) {
Craig Topperfb71b7d2017-04-14 19:20:12 +00001378 // foldOpIntoPhi will speculate instructions to the end of the PHI's
Sanjoy Dasb7e861a2016-06-05 21:17:04 +00001379 // predecessor blocks, so do this only if we know the srem or urem
1380 // will not fault.
Craig Topperfb71b7d2017-04-14 19:20:12 +00001381 if (Instruction *NV = foldOpIntoPhi(I, PN))
Sanjoy Dasb7e861a2016-06-05 21:17:04 +00001382 return NV;
1383 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001384 }
1385
1386 // See if we can fold away this rem instruction.
1387 if (SimplifyDemandedInstructionBits(I))
1388 return &I;
1389 }
1390 }
1391
Craig Topperf40110f2014-04-25 05:29:35 +00001392 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001393}
1394
1395Instruction *InstCombiner::visitURem(BinaryOperator &I) {
1396 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1397
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001398 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001399 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001400
Craig Toppera4205622017-06-09 03:21:29 +00001401 if (Value *V = SimplifyURemInst(Op0, Op1, SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001402 return replaceInstUsesWith(I, V);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001403
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001404 if (Instruction *common = commonIRemTransforms(I))
1405 return common;
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001406
Sanjay Patelbb789382017-08-24 22:54:01 +00001407 if (Instruction *NarrowRem = narrowUDivURem(I, Builder))
1408 return NarrowRem;
David Majnemer6c30f492013-05-12 00:07:05 +00001409
David Majnemer470b0772013-05-11 09:01:28 +00001410 // X urem Y -> X and Y-1, where Y is a power of 2,
Craig Topperd4039f72017-05-25 21:51:12 +00001411 if (isKnownToBeAPowerOfTwo(Op1, /*OrZero*/ true, 0, &I)) {
Chris Lattner6b657ae2011-02-10 05:36:31 +00001412 Constant *N1 = Constant::getAllOnesValue(I.getType());
Craig Topperbb4069e2017-07-07 23:16:26 +00001413 Value *Add = Builder.CreateAdd(Op1, N1);
Chris Lattner6b657ae2011-02-10 05:36:31 +00001414 return BinaryOperator::CreateAnd(Op0, Add);
1415 }
1416
Nick Lewycky7459be62013-07-13 01:16:47 +00001417 // 1 urem X -> zext(X != 1)
1418 if (match(Op0, m_One())) {
Craig Topperbb4069e2017-07-07 23:16:26 +00001419 Value *Cmp = Builder.CreateICmpNE(Op1, Op0);
1420 Value *Ext = Builder.CreateZExt(Cmp, I.getType());
Sanjay Patel4b198802016-02-01 22:23:39 +00001421 return replaceInstUsesWith(I, Ext);
Nick Lewycky7459be62013-07-13 01:16:47 +00001422 }
1423
Sanjay Patel30ef70b2016-09-22 22:36:26 +00001424 // X urem C -> X < C ? X : X - C, where C >= signbit.
Simon Pilgrim1889f262018-02-08 18:36:01 +00001425 if (match(Op1, m_Negative())) {
Craig Topperbb4069e2017-07-07 23:16:26 +00001426 Value *Cmp = Builder.CreateICmpULT(Op0, Op1);
1427 Value *Sub = Builder.CreateSub(Op0, Op1);
Sanjay Patel30ef70b2016-09-22 22:36:26 +00001428 return SelectInst::Create(Cmp, Op0, Sub);
1429 }
1430
Craig Topperf40110f2014-04-25 05:29:35 +00001431 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001432}
1433
1434Instruction *InstCombiner::visitSRem(BinaryOperator &I) {
1435 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1436
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001437 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001438 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001439
Craig Toppera4205622017-06-09 03:21:29 +00001440 if (Value *V = SimplifySRemInst(Op0, Op1, SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001441 return replaceInstUsesWith(I, V);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001442
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001443 // Handle the integer rem common cases
1444 if (Instruction *Common = commonIRemTransforms(I))
1445 return Common;
Jim Grosbachbdbd7342013-04-05 21:20:12 +00001446
David Majnemerdb077302014-10-13 22:37:51 +00001447 {
1448 const APInt *Y;
1449 // X % -Y -> X % Y
Simon Pilgrima54e8e42018-02-08 19:00:45 +00001450 if (match(Op1, m_Negative(Y)) && !Y->isMinSignedValue()) {
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001451 Worklist.AddValue(I.getOperand(1));
David Majnemerdb077302014-10-13 22:37:51 +00001452 I.setOperand(1, ConstantInt::get(I.getType(), -*Y));
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001453 return &I;
1454 }
David Majnemerdb077302014-10-13 22:37:51 +00001455 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001456
1457 // If the sign bits of both operands are zero (i.e. we can prove they are
1458 // unsigned inputs), turn this into a urem.
Craig Topperbcfd2d12017-04-20 16:56:25 +00001459 APInt Mask(APInt::getSignMask(I.getType()->getScalarSizeInBits()));
Craig Topper1a18a7c2017-04-17 01:51:24 +00001460 if (MaskedValueIsZero(Op1, Mask, 0, &I) &&
1461 MaskedValueIsZero(Op0, Mask, 0, &I)) {
1462 // X srem Y -> X urem Y, iff X and Y don't have sign bit set
1463 return BinaryOperator::CreateURem(Op0, Op1, I.getName());
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001464 }
1465
1466 // If it's a constant vector, flip any negative values positive.
Chris Lattner0256be92012-01-27 03:08:05 +00001467 if (isa<ConstantVector>(Op1) || isa<ConstantDataVector>(Op1)) {
1468 Constant *C = cast<Constant>(Op1);
1469 unsigned VWidth = C->getType()->getVectorNumElements();
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001470
1471 bool hasNegative = false;
Chris Lattner0256be92012-01-27 03:08:05 +00001472 bool hasMissing = false;
1473 for (unsigned i = 0; i != VWidth; ++i) {
1474 Constant *Elt = C->getAggregateElement(i);
Craig Topperf40110f2014-04-25 05:29:35 +00001475 if (!Elt) {
Chris Lattner0256be92012-01-27 03:08:05 +00001476 hasMissing = true;
1477 break;
1478 }
1479
1480 if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elt))
Chris Lattnerb1a15122011-07-15 06:08:15 +00001481 if (RHS->isNegative())
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001482 hasNegative = true;
Chris Lattner0256be92012-01-27 03:08:05 +00001483 }
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001484
Chris Lattner0256be92012-01-27 03:08:05 +00001485 if (hasNegative && !hasMissing) {
Chris Lattner47a86bd2012-01-25 06:02:56 +00001486 SmallVector<Constant *, 16> Elts(VWidth);
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001487 for (unsigned i = 0; i != VWidth; ++i) {
Chris Lattner8213c8a2012-02-06 21:56:39 +00001488 Elts[i] = C->getAggregateElement(i); // Handle undef, etc.
Chris Lattner0256be92012-01-27 03:08:05 +00001489 if (ConstantInt *RHS = dyn_cast<ConstantInt>(Elts[i])) {
Chris Lattnerb1a15122011-07-15 06:08:15 +00001490 if (RHS->isNegative())
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001491 Elts[i] = cast<ConstantInt>(ConstantExpr::getNeg(RHS));
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001492 }
1493 }
1494
1495 Constant *NewRHSV = ConstantVector::get(Elts);
Chris Lattner0256be92012-01-27 03:08:05 +00001496 if (NewRHSV != C) { // Don't loop on -MININT
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001497 Worklist.AddValue(I.getOperand(1));
1498 I.setOperand(1, NewRHSV);
1499 return &I;
1500 }
1501 }
1502 }
1503
Craig Topperf40110f2014-04-25 05:29:35 +00001504 return nullptr;
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001505}
1506
1507Instruction *InstCombiner::visitFRem(BinaryOperator &I) {
Duncan Sandsa3e36992011-05-02 16:27:02 +00001508 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerdc054bf2010-01-05 06:09:35 +00001509
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001510 if (Value *V = SimplifyVectorOp(I))
Sanjay Patel4b198802016-02-01 22:23:39 +00001511 return replaceInstUsesWith(I, V);
Serge Pavlov9ef66a82014-05-11 08:46:12 +00001512
Craig Toppera4205622017-06-09 03:21:29 +00001513 if (Value *V = SimplifyFRemInst(Op0, Op1, I.getFastMathFlags(),
1514 SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00001515 return replaceInstUsesWith(I, V);
Duncan Sandsa3e36992011-05-02 16:27:02 +00001516
Craig Topperf40110f2014-04-25 05:29:35 +00001517 return nullptr;
Duncan Sandsa3e36992011-05-02 16:27:02 +00001518}