blob: a295f65f3875f9b28ee8cad8879d2bea7b988ca5 [file] [log] [blame]
Chris Lattner2188e402010-01-04 07:37:31 +00001//===- InstCombineCompares.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 visitICmp and visitFCmp functions.
11//
12//===----------------------------------------------------------------------===//
13
Chandler Carrutha9174582015-01-22 05:25:13 +000014#include "InstCombineInternal.h"
Matt Arsenault55e73122015-01-06 15:50:59 +000015#include "llvm/ADT/APSInt.h"
Silviu Barangaf29dfd32016-01-15 15:52:05 +000016#include "llvm/ADT/SetVector.h"
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000017#include "llvm/ADT/Statistic.h"
Eli Friedman911e12f2011-07-20 21:57:23 +000018#include "llvm/Analysis/ConstantFolding.h"
Chris Lattner2188e402010-01-04 07:37:31 +000019#include "llvm/Analysis/InstructionSimplify.h"
Mehdi Aminib550cb12016-04-18 09:17:29 +000020#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000021#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000022#include "llvm/IR/DataLayout.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000023#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000024#include "llvm/IR/IntrinsicInst.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000025#include "llvm/IR/PatternMatch.h"
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000026#include "llvm/Support/Debug.h"
Craig Topperb45eabc2017-04-26 16:39:58 +000027#include "llvm/Support/KnownBits.h"
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000028
Chris Lattner2188e402010-01-04 07:37:31 +000029using namespace llvm;
30using namespace PatternMatch;
31
Chandler Carruth964daaa2014-04-22 02:55:47 +000032#define DEBUG_TYPE "instcombine"
33
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000034// How many times is a select replaced by one of its operands?
35STATISTIC(NumSel, "Number of select opts");
36
Chris Lattner98457102011-02-10 05:23:05 +000037
Sanjay Patel5f0217f2016-06-05 16:46:18 +000038/// Compute Result = In1+In2, returning true if the result overflowed for this
39/// type.
Craig Topper6e025a32017-10-01 23:53:54 +000040static bool addWithOverflow(APInt &Result, const APInt &In1,
41 const APInt &In2, bool IsSigned = false) {
42 bool Overflow;
43 if (IsSigned)
44 Result = In1.sadd_ov(In2, Overflow);
45 else
46 Result = In1.uadd_ov(In2, Overflow);
Chris Lattner2188e402010-01-04 07:37:31 +000047
Craig Topper6e025a32017-10-01 23:53:54 +000048 return Overflow;
Chris Lattner2188e402010-01-04 07:37:31 +000049}
50
Sanjay Patel5f0217f2016-06-05 16:46:18 +000051/// Compute Result = In1-In2, returning true if the result overflowed for this
52/// type.
Craig Topper6e025a32017-10-01 23:53:54 +000053static bool subWithOverflow(APInt &Result, const APInt &In1,
54 const APInt &In2, bool IsSigned = false) {
55 bool Overflow;
56 if (IsSigned)
57 Result = In1.ssub_ov(In2, Overflow);
58 else
59 Result = In1.usub_ov(In2, Overflow);
Chris Lattner2188e402010-01-04 07:37:31 +000060
Craig Topper6e025a32017-10-01 23:53:54 +000061 return Overflow;
Chris Lattner2188e402010-01-04 07:37:31 +000062}
63
Balaram Makam569eaec2016-05-04 21:32:14 +000064/// Given an icmp instruction, return true if any use of this comparison is a
65/// branch on sign bit comparison.
Eric Christopher710c1c82017-06-30 01:35:31 +000066static bool hasBranchUse(ICmpInst &I) {
Balaram Makam569eaec2016-05-04 21:32:14 +000067 for (auto *U : I.users())
68 if (isa<BranchInst>(U))
Eric Christopher710c1c82017-06-30 01:35:31 +000069 return true;
Balaram Makam569eaec2016-05-04 21:32:14 +000070 return false;
71}
72
Sanjay Patel5f0217f2016-06-05 16:46:18 +000073/// Given an exploded icmp instruction, return true if the comparison only
74/// checks the sign bit. If it only checks the sign bit, set TrueIfSigned if the
75/// result of the comparison is true when the input value is signed.
Sanjay Patel79263662016-08-21 15:07:45 +000076static bool isSignBitCheck(ICmpInst::Predicate Pred, const APInt &RHS,
Chris Lattner2188e402010-01-04 07:37:31 +000077 bool &TrueIfSigned) {
Sanjay Patel5f0217f2016-06-05 16:46:18 +000078 switch (Pred) {
Chris Lattner2188e402010-01-04 07:37:31 +000079 case ICmpInst::ICMP_SLT: // True if LHS s< 0
80 TrueIfSigned = true;
Craig Topper73ba1c82017-06-07 07:40:37 +000081 return RHS.isNullValue();
Chris Lattner2188e402010-01-04 07:37:31 +000082 case ICmpInst::ICMP_SLE: // True if LHS s<= RHS and RHS == -1
83 TrueIfSigned = true;
Sanjay Patel79263662016-08-21 15:07:45 +000084 return RHS.isAllOnesValue();
Chris Lattner2188e402010-01-04 07:37:31 +000085 case ICmpInst::ICMP_SGT: // True if LHS s> -1
86 TrueIfSigned = false;
Sanjay Patel79263662016-08-21 15:07:45 +000087 return RHS.isAllOnesValue();
Chris Lattner2188e402010-01-04 07:37:31 +000088 case ICmpInst::ICMP_UGT:
89 // True if LHS u> RHS and RHS == high-bit-mask - 1
90 TrueIfSigned = true;
Sanjay Patel79263662016-08-21 15:07:45 +000091 return RHS.isMaxSignedValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +000092 case ICmpInst::ICMP_UGE:
Chris Lattner2188e402010-01-04 07:37:31 +000093 // True if LHS u>= RHS and RHS == high-bit-mask (2^7, 2^15, 2^31, etc)
94 TrueIfSigned = true;
Craig Topperbcfd2d12017-04-20 16:56:25 +000095 return RHS.isSignMask();
Chris Lattner2188e402010-01-04 07:37:31 +000096 default:
97 return false;
98 }
99}
100
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000101/// Returns true if the exploded icmp can be expressed as a signed comparison
102/// to zero and updates the predicate accordingly.
103/// The signedness of the comparison is preserved.
Sanjay Patel5b112842016-08-18 14:59:14 +0000104/// TODO: Refactor with decomposeBitTestICmp()?
105static bool isSignTest(ICmpInst::Predicate &Pred, const APInt &C) {
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000106 if (!ICmpInst::isSigned(Pred))
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000107 return false;
108
Craig Topper73ba1c82017-06-07 07:40:37 +0000109 if (C.isNullValue())
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000110 return ICmpInst::isRelational(Pred);
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000111
Craig Topper73ba1c82017-06-07 07:40:37 +0000112 if (C.isOneValue()) {
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000113 if (Pred == ICmpInst::ICMP_SLT) {
114 Pred = ICmpInst::ICMP_SLE;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000115 return true;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000116 }
Sanjay Patel5b112842016-08-18 14:59:14 +0000117 } else if (C.isAllOnesValue()) {
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000118 if (Pred == ICmpInst::ICMP_SGT) {
119 Pred = ICmpInst::ICMP_SGE;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000120 return true;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000121 }
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000122 }
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000123
124 return false;
125}
126
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000127/// Given a signed integer type and a set of known zero and one bits, compute
128/// the maximum and minimum values that could have the specified known zero and
129/// known one bits, returning them in Min/Max.
Craig Topperb45eabc2017-04-26 16:39:58 +0000130/// TODO: Move to method on KnownBits struct?
131static void computeSignedMinMaxValuesFromKnownBits(const KnownBits &Known,
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000132 APInt &Min, APInt &Max) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000133 assert(Known.getBitWidth() == Min.getBitWidth() &&
134 Known.getBitWidth() == Max.getBitWidth() &&
Chris Lattner2188e402010-01-04 07:37:31 +0000135 "KnownZero, KnownOne and Min, Max must have equal bitwidth.");
Craig Topperb45eabc2017-04-26 16:39:58 +0000136 APInt UnknownBits = ~(Known.Zero|Known.One);
Chris Lattner2188e402010-01-04 07:37:31 +0000137
138 // The minimum value is when all unknown bits are zeros, EXCEPT for the sign
139 // bit if it is unknown.
Craig Topperb45eabc2017-04-26 16:39:58 +0000140 Min = Known.One;
141 Max = Known.One|UnknownBits;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000142
Chris Lattner2188e402010-01-04 07:37:31 +0000143 if (UnknownBits.isNegative()) { // Sign bit is unknown
Craig Topper24db6b82017-04-28 16:58:05 +0000144 Min.setSignBit();
145 Max.clearSignBit();
Chris Lattner2188e402010-01-04 07:37:31 +0000146 }
147}
148
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000149/// Given an unsigned integer type and a set of known zero and one bits, compute
150/// the maximum and minimum values that could have the specified known zero and
151/// known one bits, returning them in Min/Max.
Craig Topperb45eabc2017-04-26 16:39:58 +0000152/// TODO: Move to method on KnownBits struct?
153static void computeUnsignedMinMaxValuesFromKnownBits(const KnownBits &Known,
Chris Lattner2188e402010-01-04 07:37:31 +0000154 APInt &Min, APInt &Max) {
Craig Topperb45eabc2017-04-26 16:39:58 +0000155 assert(Known.getBitWidth() == Min.getBitWidth() &&
156 Known.getBitWidth() == Max.getBitWidth() &&
Chris Lattner2188e402010-01-04 07:37:31 +0000157 "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth.");
Craig Topperb45eabc2017-04-26 16:39:58 +0000158 APInt UnknownBits = ~(Known.Zero|Known.One);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000159
Chris Lattner2188e402010-01-04 07:37:31 +0000160 // The minimum value is when the unknown bits are all zeros.
Craig Topperb45eabc2017-04-26 16:39:58 +0000161 Min = Known.One;
Chris Lattner2188e402010-01-04 07:37:31 +0000162 // The maximum value is when the unknown bits are all ones.
Craig Topperb45eabc2017-04-26 16:39:58 +0000163 Max = Known.One|UnknownBits;
Chris Lattner2188e402010-01-04 07:37:31 +0000164}
165
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000166/// This is called when we see this pattern:
Chris Lattner2188e402010-01-04 07:37:31 +0000167/// cmp pred (load (gep GV, ...)), cmpcst
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000168/// where GV is a global variable with a constant initializer. Try to simplify
169/// this into some simple computation that does not need the load. For example
Chris Lattner2188e402010-01-04 07:37:31 +0000170/// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
171///
172/// If AndCst is non-null, then the loaded value is masked with that constant
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000173/// before doing the comparison. This handles cases like "A[i]&4 == 0".
Sanjay Patel43395062016-07-21 18:07:40 +0000174Instruction *InstCombiner::foldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP,
175 GlobalVariable *GV,
176 CmpInst &ICI,
177 ConstantInt *AndCst) {
Chris Lattnerfe741762012-01-31 02:55:06 +0000178 Constant *Init = GV->getInitializer();
179 if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
Craig Topperf40110f2014-04-25 05:29:35 +0000180 return nullptr;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000181
Chris Lattnerfe741762012-01-31 02:55:06 +0000182 uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
Davide Italiano2133bf52017-02-07 17:56:50 +0000183 // Don't blow up on huge arrays.
184 if (ArrayElementCount > MaxArraySizeForCombine)
185 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000186
Chris Lattner2188e402010-01-04 07:37:31 +0000187 // There are many forms of this optimization we can handle, for now, just do
188 // the simple index into a single-dimensional array.
189 //
190 // Require: GEP GV, 0, i {{, constant indices}}
191 if (GEP->getNumOperands() < 3 ||
192 !isa<ConstantInt>(GEP->getOperand(1)) ||
193 !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
194 isa<Constant>(GEP->getOperand(2)))
Craig Topperf40110f2014-04-25 05:29:35 +0000195 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000196
197 // Check that indices after the variable are constants and in-range for the
198 // type they index. Collect the indices. This is typically for arrays of
199 // structs.
200 SmallVector<unsigned, 4> LaterIndices;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000201
Chris Lattnerfe741762012-01-31 02:55:06 +0000202 Type *EltTy = Init->getType()->getArrayElementType();
Chris Lattner2188e402010-01-04 07:37:31 +0000203 for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
204 ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
Craig Topperf40110f2014-04-25 05:29:35 +0000205 if (!Idx) return nullptr; // Variable index.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000206
Chris Lattner2188e402010-01-04 07:37:31 +0000207 uint64_t IdxVal = Idx->getZExtValue();
Craig Topperf40110f2014-04-25 05:29:35 +0000208 if ((unsigned)IdxVal != IdxVal) return nullptr; // Too large array index.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000209
Chris Lattner229907c2011-07-18 04:54:35 +0000210 if (StructType *STy = dyn_cast<StructType>(EltTy))
Chris Lattner2188e402010-01-04 07:37:31 +0000211 EltTy = STy->getElementType(IdxVal);
Chris Lattner229907c2011-07-18 04:54:35 +0000212 else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
Craig Topperf40110f2014-04-25 05:29:35 +0000213 if (IdxVal >= ATy->getNumElements()) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000214 EltTy = ATy->getElementType();
215 } else {
Craig Topperf40110f2014-04-25 05:29:35 +0000216 return nullptr; // Unknown type.
Chris Lattner2188e402010-01-04 07:37:31 +0000217 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000218
Chris Lattner2188e402010-01-04 07:37:31 +0000219 LaterIndices.push_back(IdxVal);
220 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000221
Chris Lattner2188e402010-01-04 07:37:31 +0000222 enum { Overdefined = -3, Undefined = -2 };
223
224 // Variables for our state machines.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000225
Chris Lattner2188e402010-01-04 07:37:31 +0000226 // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
227 // "i == 47 | i == 87", where 47 is the first index the condition is true for,
228 // and 87 is the second (and last) index. FirstTrueElement is -2 when
229 // undefined, otherwise set to the first true element. SecondTrueElement is
230 // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
231 int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
232
233 // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
234 // form "i != 47 & i != 87". Same state transitions as for true elements.
235 int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000236
Chris Lattner2188e402010-01-04 07:37:31 +0000237 /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
238 /// define a state machine that triggers for ranges of values that the index
239 /// is true or false for. This triggers on things like "abbbbc"[i] == 'b'.
240 /// This is -2 when undefined, -3 when overdefined, and otherwise the last
241 /// index in the range (inclusive). We use -2 for undefined here because we
242 /// use relative comparisons and don't want 0-1 to match -1.
243 int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000244
Chris Lattner2188e402010-01-04 07:37:31 +0000245 // MagicBitvector - This is a magic bitvector where we set a bit if the
246 // comparison is true for element 'i'. If there are 64 elements or less in
247 // the array, this will fully represent all the comparison results.
248 uint64_t MagicBitvector = 0;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000249
Chris Lattner2188e402010-01-04 07:37:31 +0000250 // Scan the array and see if one of our patterns matches.
251 Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
Chris Lattnerfe741762012-01-31 02:55:06 +0000252 for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
253 Constant *Elt = Init->getAggregateElement(i);
Craig Topperf40110f2014-04-25 05:29:35 +0000254 if (!Elt) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000255
Chris Lattner2188e402010-01-04 07:37:31 +0000256 // If this is indexing an array of structures, get the structure element.
257 if (!LaterIndices.empty())
Jay Foad57aa6362011-07-13 10:26:04 +0000258 Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000259
Chris Lattner2188e402010-01-04 07:37:31 +0000260 // If the element is masked, handle it.
261 if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000262
Chris Lattner2188e402010-01-04 07:37:31 +0000263 // Find out if the comparison would be true or false for the i'th element.
264 Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
Justin Bogner99798402016-08-05 01:06:44 +0000265 CompareRHS, DL, &TLI);
Chris Lattner2188e402010-01-04 07:37:31 +0000266 // If the result is undef for this element, ignore it.
267 if (isa<UndefValue>(C)) {
268 // Extend range state machines to cover this element in case there is an
269 // undef in the middle of the range.
270 if (TrueRangeEnd == (int)i-1)
271 TrueRangeEnd = i;
272 if (FalseRangeEnd == (int)i-1)
273 FalseRangeEnd = i;
274 continue;
275 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000276
Chris Lattner2188e402010-01-04 07:37:31 +0000277 // If we can't compute the result for any of the elements, we have to give
278 // up evaluating the entire conditional.
Craig Topperf40110f2014-04-25 05:29:35 +0000279 if (!isa<ConstantInt>(C)) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000280
Chris Lattner2188e402010-01-04 07:37:31 +0000281 // Otherwise, we know if the comparison is true or false for this element,
282 // update our state machines.
283 bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000284
Chris Lattner2188e402010-01-04 07:37:31 +0000285 // State machine for single/double/range index comparison.
286 if (IsTrueForElt) {
287 // Update the TrueElement state machine.
288 if (FirstTrueElement == Undefined)
289 FirstTrueElement = TrueRangeEnd = i; // First true element.
290 else {
291 // Update double-compare state machine.
292 if (SecondTrueElement == Undefined)
293 SecondTrueElement = i;
294 else
295 SecondTrueElement = Overdefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000296
Chris Lattner2188e402010-01-04 07:37:31 +0000297 // Update range state machine.
298 if (TrueRangeEnd == (int)i-1)
299 TrueRangeEnd = i;
300 else
301 TrueRangeEnd = Overdefined;
302 }
303 } else {
304 // Update the FalseElement state machine.
305 if (FirstFalseElement == Undefined)
306 FirstFalseElement = FalseRangeEnd = i; // First false element.
307 else {
308 // Update double-compare state machine.
309 if (SecondFalseElement == Undefined)
310 SecondFalseElement = i;
311 else
312 SecondFalseElement = Overdefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000313
Chris Lattner2188e402010-01-04 07:37:31 +0000314 // Update range state machine.
315 if (FalseRangeEnd == (int)i-1)
316 FalseRangeEnd = i;
317 else
318 FalseRangeEnd = Overdefined;
319 }
320 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000321
Chris Lattner2188e402010-01-04 07:37:31 +0000322 // If this element is in range, update our magic bitvector.
323 if (i < 64 && IsTrueForElt)
324 MagicBitvector |= 1ULL << i;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000325
Chris Lattner2188e402010-01-04 07:37:31 +0000326 // If all of our states become overdefined, bail out early. Since the
327 // predicate is expensive, only check it every 8 elements. This is only
328 // really useful for really huge arrays.
329 if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
330 SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
331 FalseRangeEnd == Overdefined)
Craig Topperf40110f2014-04-25 05:29:35 +0000332 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000333 }
334
335 // Now that we've scanned the entire array, emit our new comparison(s). We
336 // order the state machines in complexity of the generated code.
337 Value *Idx = GEP->getOperand(2);
338
Matt Arsenault5aeae182013-08-19 21:40:31 +0000339 // If the index is larger than the pointer size of the target, truncate the
340 // index down like the GEP would do implicitly. We don't have to do this for
341 // an inbounds GEP because the index can't be out of range.
Matt Arsenault84680622013-09-30 21:11:01 +0000342 if (!GEP->isInBounds()) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000343 Type *IntPtrTy = DL.getIntPtrType(GEP->getType());
Matt Arsenault84680622013-09-30 21:11:01 +0000344 unsigned PtrSize = IntPtrTy->getIntegerBitWidth();
345 if (Idx->getType()->getPrimitiveSizeInBits() > PtrSize)
Craig Topperbb4069e2017-07-07 23:16:26 +0000346 Idx = Builder.CreateTrunc(Idx, IntPtrTy);
Matt Arsenault84680622013-09-30 21:11:01 +0000347 }
Matt Arsenault5aeae182013-08-19 21:40:31 +0000348
Chris Lattner2188e402010-01-04 07:37:31 +0000349 // If the comparison is only true for one or two elements, emit direct
350 // comparisons.
351 if (SecondTrueElement != Overdefined) {
352 // None true -> false.
353 if (FirstTrueElement == Undefined)
Craig Topperbb4069e2017-07-07 23:16:26 +0000354 return replaceInstUsesWith(ICI, Builder.getFalse());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000355
Chris Lattner2188e402010-01-04 07:37:31 +0000356 Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000357
Chris Lattner2188e402010-01-04 07:37:31 +0000358 // True for one element -> 'i == 47'.
359 if (SecondTrueElement == Undefined)
360 return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000361
Chris Lattner2188e402010-01-04 07:37:31 +0000362 // True for two elements -> 'i == 47 | i == 72'.
Craig Topperbb4069e2017-07-07 23:16:26 +0000363 Value *C1 = Builder.CreateICmpEQ(Idx, FirstTrueIdx);
Chris Lattner2188e402010-01-04 07:37:31 +0000364 Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
Craig Topperbb4069e2017-07-07 23:16:26 +0000365 Value *C2 = Builder.CreateICmpEQ(Idx, SecondTrueIdx);
Chris Lattner2188e402010-01-04 07:37:31 +0000366 return BinaryOperator::CreateOr(C1, C2);
367 }
368
369 // If the comparison is only false for one or two elements, emit direct
370 // comparisons.
371 if (SecondFalseElement != Overdefined) {
372 // None false -> true.
373 if (FirstFalseElement == Undefined)
Craig Topperbb4069e2017-07-07 23:16:26 +0000374 return replaceInstUsesWith(ICI, Builder.getTrue());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000375
Chris Lattner2188e402010-01-04 07:37:31 +0000376 Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
377
378 // False for one element -> 'i != 47'.
379 if (SecondFalseElement == Undefined)
380 return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000381
Chris Lattner2188e402010-01-04 07:37:31 +0000382 // False for two elements -> 'i != 47 & i != 72'.
Craig Topperbb4069e2017-07-07 23:16:26 +0000383 Value *C1 = Builder.CreateICmpNE(Idx, FirstFalseIdx);
Chris Lattner2188e402010-01-04 07:37:31 +0000384 Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
Craig Topperbb4069e2017-07-07 23:16:26 +0000385 Value *C2 = Builder.CreateICmpNE(Idx, SecondFalseIdx);
Chris Lattner2188e402010-01-04 07:37:31 +0000386 return BinaryOperator::CreateAnd(C1, C2);
387 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000388
Chris Lattner2188e402010-01-04 07:37:31 +0000389 // If the comparison can be replaced with a range comparison for the elements
390 // where it is true, emit the range check.
391 if (TrueRangeEnd != Overdefined) {
392 assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
Jim Grosbach129c52a2011-09-30 18:09:53 +0000393
Chris Lattner2188e402010-01-04 07:37:31 +0000394 // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
395 if (FirstTrueElement) {
396 Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
Craig Topperbb4069e2017-07-07 23:16:26 +0000397 Idx = Builder.CreateAdd(Idx, Offs);
Chris Lattner2188e402010-01-04 07:37:31 +0000398 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000399
Chris Lattner2188e402010-01-04 07:37:31 +0000400 Value *End = ConstantInt::get(Idx->getType(),
401 TrueRangeEnd-FirstTrueElement+1);
402 return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
403 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000404
Chris Lattner2188e402010-01-04 07:37:31 +0000405 // False range check.
406 if (FalseRangeEnd != Overdefined) {
407 assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
408 // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
409 if (FirstFalseElement) {
410 Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
Craig Topperbb4069e2017-07-07 23:16:26 +0000411 Idx = Builder.CreateAdd(Idx, Offs);
Chris Lattner2188e402010-01-04 07:37:31 +0000412 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000413
Chris Lattner2188e402010-01-04 07:37:31 +0000414 Value *End = ConstantInt::get(Idx->getType(),
415 FalseRangeEnd-FirstFalseElement);
416 return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
417 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000418
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000419 // If a magic bitvector captures the entire comparison state
Chris Lattner2188e402010-01-04 07:37:31 +0000420 // of this load, replace it with computation that does:
421 // ((magic_cst >> i) & 1) != 0
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000422 {
Craig Topperf40110f2014-04-25 05:29:35 +0000423 Type *Ty = nullptr;
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000424
425 // Look for an appropriate type:
426 // - The type of Idx if the magic fits
Craig Topper386fc252017-11-07 17:37:32 +0000427 // - The smallest fitting legal type
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000428 if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
429 Ty = Idx->getType();
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000430 else
431 Ty = DL.getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000432
Craig Topperf40110f2014-04-25 05:29:35 +0000433 if (Ty) {
Craig Topperbb4069e2017-07-07 23:16:26 +0000434 Value *V = Builder.CreateIntCast(Idx, Ty, false);
435 V = Builder.CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
436 V = Builder.CreateAnd(ConstantInt::get(Ty, 1), V);
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000437 return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
438 }
Chris Lattner2188e402010-01-04 07:37:31 +0000439 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000440
Craig Topperf40110f2014-04-25 05:29:35 +0000441 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000442}
443
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000444/// Return a value that can be used to compare the *offset* implied by a GEP to
445/// zero. For example, if we have &A[i], we want to return 'i' for
446/// "icmp ne i, 0". Note that, in general, indices can be complex, and scales
447/// are involved. The above expression would also be legal to codegen as
448/// "icmp ne (i*4), 0" (assuming A is a pointer to i32).
449/// This latter form is less amenable to optimization though, and we are allowed
Chris Lattner2188e402010-01-04 07:37:31 +0000450/// to generate the first by knowing that pointer arithmetic doesn't overflow.
451///
452/// If we can't emit an optimized form for this expression, this returns null.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000453///
Sanjay Pateld93c4c02016-09-15 18:22:25 +0000454static Value *evaluateGEPOffsetExpression(User *GEP, InstCombiner &IC,
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000455 const DataLayout &DL) {
Chris Lattner2188e402010-01-04 07:37:31 +0000456 gep_type_iterator GTI = gep_type_begin(GEP);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000457
Chris Lattner2188e402010-01-04 07:37:31 +0000458 // Check to see if this gep only has a single variable index. If so, and if
459 // any constant indices are a multiple of its scale, then we can compute this
460 // in terms of the scale of the variable index. For example, if the GEP
461 // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
462 // because the expression will cross zero at the same point.
463 unsigned i, e = GEP->getNumOperands();
464 int64_t Offset = 0;
465 for (i = 1; i != e; ++i, ++GTI) {
466 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
467 // Compute the aggregate offset of constant indices.
468 if (CI->isZero()) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000469
Chris Lattner2188e402010-01-04 07:37:31 +0000470 // Handle a struct index, which adds its field offset to the pointer.
Peter Collingbourneab85225b2016-12-02 02:24:42 +0000471 if (StructType *STy = GTI.getStructTypeOrNull()) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000472 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
Chris Lattner2188e402010-01-04 07:37:31 +0000473 } else {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000474 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner2188e402010-01-04 07:37:31 +0000475 Offset += Size*CI->getSExtValue();
476 }
477 } else {
478 // Found our variable index.
479 break;
480 }
481 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000482
Chris Lattner2188e402010-01-04 07:37:31 +0000483 // If there are no variable indices, we must have a constant offset, just
484 // evaluate it the general way.
Craig Topperf40110f2014-04-25 05:29:35 +0000485 if (i == e) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000486
Chris Lattner2188e402010-01-04 07:37:31 +0000487 Value *VariableIdx = GEP->getOperand(i);
488 // Determine the scale factor of the variable element. For example, this is
489 // 4 if the variable index is into an array of i32.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000490 uint64_t VariableScale = DL.getTypeAllocSize(GTI.getIndexedType());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000491
Chris Lattner2188e402010-01-04 07:37:31 +0000492 // Verify that there are no other variable indices. If so, emit the hard way.
493 for (++i, ++GTI; i != e; ++i, ++GTI) {
494 ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
Craig Topperf40110f2014-04-25 05:29:35 +0000495 if (!CI) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000496
Chris Lattner2188e402010-01-04 07:37:31 +0000497 // Compute the aggregate offset of constant indices.
498 if (CI->isZero()) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000499
Chris Lattner2188e402010-01-04 07:37:31 +0000500 // Handle a struct index, which adds its field offset to the pointer.
Peter Collingbourneab85225b2016-12-02 02:24:42 +0000501 if (StructType *STy = GTI.getStructTypeOrNull()) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000502 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
Chris Lattner2188e402010-01-04 07:37:31 +0000503 } else {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000504 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner2188e402010-01-04 07:37:31 +0000505 Offset += Size*CI->getSExtValue();
506 }
507 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000508
Chris Lattner2188e402010-01-04 07:37:31 +0000509 // Okay, we know we have a single variable index, which must be a
510 // pointer/array/vector index. If there is no offset, life is simple, return
511 // the index.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000512 Type *IntPtrTy = DL.getIntPtrType(GEP->getOperand(0)->getType());
Matt Arsenault745101d2013-08-21 19:53:10 +0000513 unsigned IntPtrWidth = IntPtrTy->getIntegerBitWidth();
Chris Lattner2188e402010-01-04 07:37:31 +0000514 if (Offset == 0) {
515 // Cast to intptrty in case a truncation occurs. If an extension is needed,
516 // we don't need to bother extending: the extension won't affect where the
517 // computation crosses zero.
Eli Friedman1754a252011-05-18 23:11:30 +0000518 if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) {
Craig Topperbb4069e2017-07-07 23:16:26 +0000519 VariableIdx = IC.Builder.CreateTrunc(VariableIdx, IntPtrTy);
Eli Friedman1754a252011-05-18 23:11:30 +0000520 }
Chris Lattner2188e402010-01-04 07:37:31 +0000521 return VariableIdx;
522 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000523
Chris Lattner2188e402010-01-04 07:37:31 +0000524 // Otherwise, there is an index. The computation we will do will be modulo
525 // the pointer size, so get it.
526 uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000527
Chris Lattner2188e402010-01-04 07:37:31 +0000528 Offset &= PtrSizeMask;
529 VariableScale &= PtrSizeMask;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000530
Chris Lattner2188e402010-01-04 07:37:31 +0000531 // To do this transformation, any constant index must be a multiple of the
532 // variable scale factor. For example, we can evaluate "12 + 4*i" as "3 + i",
533 // but we can't evaluate "10 + 3*i" in terms of i. Check that the offset is a
534 // multiple of the variable scale.
535 int64_t NewOffs = Offset / (int64_t)VariableScale;
536 if (Offset != NewOffs*(int64_t)VariableScale)
Craig Topperf40110f2014-04-25 05:29:35 +0000537 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000538
Chris Lattner2188e402010-01-04 07:37:31 +0000539 // Okay, we can do this evaluation. Start by converting the index to intptr.
Chris Lattner2188e402010-01-04 07:37:31 +0000540 if (VariableIdx->getType() != IntPtrTy)
Craig Topperbb4069e2017-07-07 23:16:26 +0000541 VariableIdx = IC.Builder.CreateIntCast(VariableIdx, IntPtrTy,
Eli Friedman1754a252011-05-18 23:11:30 +0000542 true /*Signed*/);
Chris Lattner2188e402010-01-04 07:37:31 +0000543 Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
Craig Topperbb4069e2017-07-07 23:16:26 +0000544 return IC.Builder.CreateAdd(VariableIdx, OffsetVal, "offset");
Chris Lattner2188e402010-01-04 07:37:31 +0000545}
546
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000547/// Returns true if we can rewrite Start as a GEP with pointer Base
548/// and some integer offset. The nodes that need to be re-written
549/// for this transformation will be added to Explored.
550static bool canRewriteGEPAsOffset(Value *Start, Value *Base,
551 const DataLayout &DL,
552 SetVector<Value *> &Explored) {
553 SmallVector<Value *, 16> WorkList(1, Start);
554 Explored.insert(Base);
555
556 // The following traversal gives us an order which can be used
557 // when doing the final transformation. Since in the final
558 // transformation we create the PHI replacement instructions first,
559 // we don't have to get them in any particular order.
560 //
561 // However, for other instructions we will have to traverse the
562 // operands of an instruction first, which means that we have to
563 // do a post-order traversal.
564 while (!WorkList.empty()) {
565 SetVector<PHINode *> PHIs;
566
567 while (!WorkList.empty()) {
568 if (Explored.size() >= 100)
569 return false;
570
571 Value *V = WorkList.back();
572
573 if (Explored.count(V) != 0) {
574 WorkList.pop_back();
575 continue;
576 }
577
578 if (!isa<IntToPtrInst>(V) && !isa<PtrToIntInst>(V) &&
David Majnemer8b16da82016-09-15 20:10:09 +0000579 !isa<GetElementPtrInst>(V) && !isa<PHINode>(V))
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000580 // We've found some value that we can't explore which is different from
581 // the base. Therefore we can't do this transformation.
582 return false;
583
584 if (isa<IntToPtrInst>(V) || isa<PtrToIntInst>(V)) {
585 auto *CI = dyn_cast<CastInst>(V);
586 if (!CI->isNoopCast(DL))
587 return false;
588
589 if (Explored.count(CI->getOperand(0)) == 0)
590 WorkList.push_back(CI->getOperand(0));
591 }
592
593 if (auto *GEP = dyn_cast<GEPOperator>(V)) {
594 // We're limiting the GEP to having one index. This will preserve
595 // the original pointer type. We could handle more cases in the
596 // future.
597 if (GEP->getNumIndices() != 1 || !GEP->isInBounds() ||
598 GEP->getType() != Start->getType())
599 return false;
600
601 if (Explored.count(GEP->getOperand(0)) == 0)
602 WorkList.push_back(GEP->getOperand(0));
603 }
604
605 if (WorkList.back() == V) {
606 WorkList.pop_back();
607 // We've finished visiting this node, mark it as such.
608 Explored.insert(V);
609 }
610
611 if (auto *PN = dyn_cast<PHINode>(V)) {
David Majnemercdf28732016-03-19 04:39:52 +0000612 // We cannot transform PHIs on unsplittable basic blocks.
613 if (isa<CatchSwitchInst>(PN->getParent()->getTerminator()))
614 return false;
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000615 Explored.insert(PN);
616 PHIs.insert(PN);
617 }
618 }
619
620 // Explore the PHI nodes further.
621 for (auto *PN : PHIs)
622 for (Value *Op : PN->incoming_values())
623 if (Explored.count(Op) == 0)
624 WorkList.push_back(Op);
625 }
626
627 // Make sure that we can do this. Since we can't insert GEPs in a basic
628 // block before a PHI node, we can't easily do this transformation if
629 // we have PHI node users of transformed instructions.
630 for (Value *Val : Explored) {
631 for (Value *Use : Val->uses()) {
632
633 auto *PHI = dyn_cast<PHINode>(Use);
634 auto *Inst = dyn_cast<Instruction>(Val);
635
636 if (Inst == Base || Inst == PHI || !Inst || !PHI ||
637 Explored.count(PHI) == 0)
638 continue;
639
640 if (PHI->getParent() == Inst->getParent())
641 return false;
642 }
643 }
644 return true;
645}
646
647// Sets the appropriate insert point on Builder where we can add
648// a replacement Instruction for V (if that is possible).
649static void setInsertionPoint(IRBuilder<> &Builder, Value *V,
650 bool Before = true) {
651 if (auto *PHI = dyn_cast<PHINode>(V)) {
652 Builder.SetInsertPoint(&*PHI->getParent()->getFirstInsertionPt());
653 return;
654 }
655 if (auto *I = dyn_cast<Instruction>(V)) {
656 if (!Before)
657 I = &*std::next(I->getIterator());
658 Builder.SetInsertPoint(I);
659 return;
660 }
661 if (auto *A = dyn_cast<Argument>(V)) {
662 // Set the insertion point in the entry block.
663 BasicBlock &Entry = A->getParent()->getEntryBlock();
664 Builder.SetInsertPoint(&*Entry.getFirstInsertionPt());
665 return;
666 }
667 // Otherwise, this is a constant and we don't need to set a new
668 // insertion point.
669 assert(isa<Constant>(V) && "Setting insertion point for unknown value!");
670}
671
672/// Returns a re-written value of Start as an indexed GEP using Base as a
673/// pointer.
674static Value *rewriteGEPAsOffset(Value *Start, Value *Base,
675 const DataLayout &DL,
676 SetVector<Value *> &Explored) {
677 // Perform all the substitutions. This is a bit tricky because we can
678 // have cycles in our use-def chains.
679 // 1. Create the PHI nodes without any incoming values.
680 // 2. Create all the other values.
681 // 3. Add the edges for the PHI nodes.
682 // 4. Emit GEPs to get the original pointers.
683 // 5. Remove the original instructions.
684 Type *IndexType = IntegerType::get(
Elena Demikhovsky945b7e52018-02-14 06:58:08 +0000685 Base->getContext(), DL.getIndexTypeSizeInBits(Start->getType()));
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000686
687 DenseMap<Value *, Value *> NewInsts;
688 NewInsts[Base] = ConstantInt::getNullValue(IndexType);
689
690 // Create the new PHI nodes, without adding any incoming values.
691 for (Value *Val : Explored) {
692 if (Val == Base)
693 continue;
694 // Create empty phi nodes. This avoids cyclic dependencies when creating
695 // the remaining instructions.
696 if (auto *PHI = dyn_cast<PHINode>(Val))
697 NewInsts[PHI] = PHINode::Create(IndexType, PHI->getNumIncomingValues(),
698 PHI->getName() + ".idx", PHI);
699 }
700 IRBuilder<> Builder(Base->getContext());
701
702 // Create all the other instructions.
703 for (Value *Val : Explored) {
704
705 if (NewInsts.find(Val) != NewInsts.end())
706 continue;
707
708 if (auto *CI = dyn_cast<CastInst>(Val)) {
709 NewInsts[CI] = NewInsts[CI->getOperand(0)];
710 continue;
711 }
712 if (auto *GEP = dyn_cast<GEPOperator>(Val)) {
713 Value *Index = NewInsts[GEP->getOperand(1)] ? NewInsts[GEP->getOperand(1)]
714 : GEP->getOperand(1);
715 setInsertionPoint(Builder, GEP);
716 // Indices might need to be sign extended. GEPs will magically do
717 // this, but we need to do it ourselves here.
718 if (Index->getType()->getScalarSizeInBits() !=
719 NewInsts[GEP->getOperand(0)]->getType()->getScalarSizeInBits()) {
720 Index = Builder.CreateSExtOrTrunc(
721 Index, NewInsts[GEP->getOperand(0)]->getType(),
722 GEP->getOperand(0)->getName() + ".sext");
723 }
724
725 auto *Op = NewInsts[GEP->getOperand(0)];
Craig Topper781aa182018-05-05 01:57:00 +0000726 if (isa<ConstantInt>(Op) && cast<ConstantInt>(Op)->isZero())
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000727 NewInsts[GEP] = Index;
728 else
729 NewInsts[GEP] = Builder.CreateNSWAdd(
730 Op, Index, GEP->getOperand(0)->getName() + ".add");
731 continue;
732 }
733 if (isa<PHINode>(Val))
734 continue;
735
736 llvm_unreachable("Unexpected instruction type");
737 }
738
739 // Add the incoming values to the PHI nodes.
740 for (Value *Val : Explored) {
741 if (Val == Base)
742 continue;
743 // All the instructions have been created, we can now add edges to the
744 // phi nodes.
745 if (auto *PHI = dyn_cast<PHINode>(Val)) {
746 PHINode *NewPhi = static_cast<PHINode *>(NewInsts[PHI]);
747 for (unsigned I = 0, E = PHI->getNumIncomingValues(); I < E; ++I) {
748 Value *NewIncoming = PHI->getIncomingValue(I);
749
750 if (NewInsts.find(NewIncoming) != NewInsts.end())
751 NewIncoming = NewInsts[NewIncoming];
752
753 NewPhi->addIncoming(NewIncoming, PHI->getIncomingBlock(I));
754 }
755 }
756 }
757
758 for (Value *Val : Explored) {
759 if (Val == Base)
760 continue;
761
762 // Depending on the type, for external users we have to emit
763 // a GEP or a GEP + ptrtoint.
764 setInsertionPoint(Builder, Val, false);
765
766 // If required, create an inttoptr instruction for Base.
767 Value *NewBase = Base;
768 if (!Base->getType()->isPointerTy())
769 NewBase = Builder.CreateBitOrPointerCast(Base, Start->getType(),
770 Start->getName() + "to.ptr");
771
772 Value *GEP = Builder.CreateInBoundsGEP(
773 Start->getType()->getPointerElementType(), NewBase,
774 makeArrayRef(NewInsts[Val]), Val->getName() + ".ptr");
775
776 if (!Val->getType()->isPointerTy()) {
777 Value *Cast = Builder.CreatePointerCast(GEP, Val->getType(),
778 Val->getName() + ".conv");
779 GEP = Cast;
780 }
781 Val->replaceAllUsesWith(GEP);
782 }
783
784 return NewInsts[Start];
785}
786
787/// Looks through GEPs, IntToPtrInsts and PtrToIntInsts in order to express
788/// the input Value as a constant indexed GEP. Returns a pair containing
789/// the GEPs Pointer and Index.
790static std::pair<Value *, Value *>
791getAsConstantIndexedAddress(Value *V, const DataLayout &DL) {
792 Type *IndexType = IntegerType::get(V->getContext(),
Elena Demikhovsky945b7e52018-02-14 06:58:08 +0000793 DL.getIndexTypeSizeInBits(V->getType()));
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000794
795 Constant *Index = ConstantInt::getNullValue(IndexType);
796 while (true) {
797 if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
798 // We accept only inbouds GEPs here to exclude the possibility of
799 // overflow.
800 if (!GEP->isInBounds())
801 break;
802 if (GEP->hasAllConstantIndices() && GEP->getNumIndices() == 1 &&
803 GEP->getType() == V->getType()) {
804 V = GEP->getOperand(0);
805 Constant *GEPIndex = static_cast<Constant *>(GEP->getOperand(1));
806 Index = ConstantExpr::getAdd(
807 Index, ConstantExpr::getSExtOrBitCast(GEPIndex, IndexType));
808 continue;
809 }
810 break;
811 }
812 if (auto *CI = dyn_cast<IntToPtrInst>(V)) {
813 if (!CI->isNoopCast(DL))
814 break;
815 V = CI->getOperand(0);
816 continue;
817 }
818 if (auto *CI = dyn_cast<PtrToIntInst>(V)) {
819 if (!CI->isNoopCast(DL))
820 break;
821 V = CI->getOperand(0);
822 continue;
823 }
824 break;
825 }
826 return {V, Index};
827}
828
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000829/// Converts (CMP GEPLHS, RHS) if this change would make RHS a constant.
830/// We can look through PHIs, GEPs and casts in order to determine a common base
831/// between GEPLHS and RHS.
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000832static Instruction *transformToIndexedCompare(GEPOperator *GEPLHS, Value *RHS,
833 ICmpInst::Predicate Cond,
834 const DataLayout &DL) {
835 if (!GEPLHS->hasAllConstantIndices())
836 return nullptr;
837
Silviu Barangac6d21eb2017-01-31 14:04:15 +0000838 // Make sure the pointers have the same type.
839 if (GEPLHS->getType() != RHS->getType())
840 return nullptr;
841
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000842 Value *PtrBase, *Index;
843 std::tie(PtrBase, Index) = getAsConstantIndexedAddress(GEPLHS, DL);
844
845 // The set of nodes that will take part in this transformation.
846 SetVector<Value *> Nodes;
847
848 if (!canRewriteGEPAsOffset(RHS, PtrBase, DL, Nodes))
849 return nullptr;
850
851 // We know we can re-write this as
852 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2)
853 // Since we've only looked through inbouds GEPs we know that we
854 // can't have overflow on either side. We can therefore re-write
855 // this as:
856 // OFFSET1 cmp OFFSET2
857 Value *NewRHS = rewriteGEPAsOffset(RHS, PtrBase, DL, Nodes);
858
859 // RewriteGEPAsOffset has replaced RHS and all of its uses with a re-written
860 // GEP having PtrBase as the pointer base, and has returned in NewRHS the
861 // offset. Since Index is the offset of LHS to the base pointer, we will now
862 // compare the offsets instead of comparing the pointers.
863 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Index, NewRHS);
864}
865
Sanjay Patel5f0217f2016-06-05 16:46:18 +0000866/// Fold comparisons between a GEP instruction and something else. At this point
867/// we know that the GEP is on the LHS of the comparison.
Sanjay Patel43395062016-07-21 18:07:40 +0000868Instruction *InstCombiner::foldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
Chris Lattner2188e402010-01-04 07:37:31 +0000869 ICmpInst::Predicate Cond,
870 Instruction &I) {
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000871 // Don't transform signed compares of GEPs into index compares. Even if the
872 // GEP is inbounds, the final add of the base pointer can have signed overflow
873 // and would change the result of the icmp.
874 // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
Benjamin Kramerc7a22fe2012-02-21 13:40:06 +0000875 // the maximum signed value for the pointer type.
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000876 if (ICmpInst::isSigned(Cond))
Craig Topperf40110f2014-04-25 05:29:35 +0000877 return nullptr;
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000878
Matt Arsenault44f60d02014-06-09 19:20:29 +0000879 // Look through bitcasts and addrspacecasts. We do not however want to remove
880 // 0 GEPs.
881 if (!isa<GetElementPtrInst>(RHS))
882 RHS = RHS->stripPointerCasts();
Chris Lattner2188e402010-01-04 07:37:31 +0000883
884 Value *PtrBase = GEPLHS->getOperand(0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000885 if (PtrBase == RHS && GEPLHS->isInBounds()) {
Chris Lattner2188e402010-01-04 07:37:31 +0000886 // ((gep Ptr, OFFSET) cmp Ptr) ---> (OFFSET cmp 0).
887 // This transformation (ignoring the base and scales) is valid because we
888 // know pointers can't overflow since the gep is inbounds. See if we can
889 // output an optimized form.
Sanjay Pateld93c4c02016-09-15 18:22:25 +0000890 Value *Offset = evaluateGEPOffsetExpression(GEPLHS, *this, DL);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000891
Chris Lattner2188e402010-01-04 07:37:31 +0000892 // If not, synthesize the offset the hard way.
Craig Topperf40110f2014-04-25 05:29:35 +0000893 if (!Offset)
Chris Lattner2188e402010-01-04 07:37:31 +0000894 Offset = EmitGEPOffset(GEPLHS);
895 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
896 Constant::getNullValue(Offset->getType()));
897 } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
898 // If the base pointers are different, but the indices are the same, just
899 // compare the base pointer.
900 if (PtrBase != GEPRHS->getOperand(0)) {
901 bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
902 IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
903 GEPRHS->getOperand(0)->getType();
904 if (IndicesTheSame)
905 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
906 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
907 IndicesTheSame = false;
908 break;
909 }
910
911 // If all indices are the same, just compare the base pointers.
912 if (IndicesTheSame)
David Majnemer5953d372013-06-29 10:28:04 +0000913 return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +0000914
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000915 // If we're comparing GEPs with two base pointers that only differ in type
916 // and both GEPs have only constant indices or just one use, then fold
917 // the compare with the adjusted indices.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000918 if (GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000919 (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
920 (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
921 PtrBase->stripPointerCasts() ==
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000922 GEPRHS->getOperand(0)->stripPointerCasts()) {
Matt Arsenault44f60d02014-06-09 19:20:29 +0000923 Value *LOffset = EmitGEPOffset(GEPLHS);
924 Value *ROffset = EmitGEPOffset(GEPRHS);
925
926 // If we looked through an addrspacecast between different sized address
927 // spaces, the LHS and RHS pointers are different sized
928 // integers. Truncate to the smaller one.
929 Type *LHSIndexTy = LOffset->getType();
930 Type *RHSIndexTy = ROffset->getType();
931 if (LHSIndexTy != RHSIndexTy) {
932 if (LHSIndexTy->getPrimitiveSizeInBits() <
933 RHSIndexTy->getPrimitiveSizeInBits()) {
Craig Topperbb4069e2017-07-07 23:16:26 +0000934 ROffset = Builder.CreateTrunc(ROffset, LHSIndexTy);
Matt Arsenault44f60d02014-06-09 19:20:29 +0000935 } else
Craig Topperbb4069e2017-07-07 23:16:26 +0000936 LOffset = Builder.CreateTrunc(LOffset, RHSIndexTy);
Matt Arsenault44f60d02014-06-09 19:20:29 +0000937 }
938
Craig Topperbb4069e2017-07-07 23:16:26 +0000939 Value *Cmp = Builder.CreateICmp(ICmpInst::getSignedPredicate(Cond),
940 LOffset, ROffset);
Sanjay Patel4b198802016-02-01 22:23:39 +0000941 return replaceInstUsesWith(I, Cmp);
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000942 }
943
Chris Lattner2188e402010-01-04 07:37:31 +0000944 // Otherwise, the base pointers are different and the indices are
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000945 // different. Try convert this to an indexed compare by looking through
946 // PHIs/casts.
947 return transformToIndexedCompare(GEPLHS, RHS, Cond, DL);
Chris Lattner2188e402010-01-04 07:37:31 +0000948 }
949
950 // If one of the GEPs has all zero indices, recurse.
Benjamin Kramerd0993e02014-07-07 11:01:16 +0000951 if (GEPLHS->hasAllZeroIndices())
Sanjay Patel43395062016-07-21 18:07:40 +0000952 return foldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
David Majnemer92a8a7d2013-06-29 09:45:35 +0000953 ICmpInst::getSwappedPredicate(Cond), I);
Chris Lattner2188e402010-01-04 07:37:31 +0000954
955 // If the other GEP has all zero indices, recurse.
Benjamin Kramerd0993e02014-07-07 11:01:16 +0000956 if (GEPRHS->hasAllZeroIndices())
Sanjay Patel43395062016-07-21 18:07:40 +0000957 return foldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
Chris Lattner2188e402010-01-04 07:37:31 +0000958
Stuart Hastings66a82b92011-05-14 05:55:10 +0000959 bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
Chris Lattner2188e402010-01-04 07:37:31 +0000960 if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) {
961 // If the GEPs only differ by one index, compare it.
962 unsigned NumDifferences = 0; // Keep track of # differences.
963 unsigned DiffOperand = 0; // The operand that differs.
964 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
965 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
966 if (GEPLHS->getOperand(i)->getType()->getPrimitiveSizeInBits() !=
967 GEPRHS->getOperand(i)->getType()->getPrimitiveSizeInBits()) {
968 // Irreconcilable differences.
969 NumDifferences = 2;
970 break;
971 } else {
972 if (NumDifferences++) break;
973 DiffOperand = i;
974 }
975 }
976
Rafael Espindolaa7bbc0b2013-06-06 17:03:05 +0000977 if (NumDifferences == 0) // SAME GEP?
Sanjay Patel4b198802016-02-01 22:23:39 +0000978 return replaceInstUsesWith(I, // No comparison is needed here.
Craig Topperbb4069e2017-07-07 23:16:26 +0000979 Builder.getInt1(ICmpInst::isTrueWhenEqual(Cond)));
Chris Lattner2188e402010-01-04 07:37:31 +0000980
Stuart Hastings66a82b92011-05-14 05:55:10 +0000981 else if (NumDifferences == 1 && GEPsInBounds) {
Chris Lattner2188e402010-01-04 07:37:31 +0000982 Value *LHSV = GEPLHS->getOperand(DiffOperand);
983 Value *RHSV = GEPRHS->getOperand(DiffOperand);
984 // Make sure we do a signed comparison here.
985 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV);
986 }
987 }
988
989 // Only lower this if the icmp is the only user of the GEP or if we expect
990 // the result to fold to a constant!
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000991 if (GEPsInBounds && (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) &&
Chris Lattner2188e402010-01-04 07:37:31 +0000992 (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) {
993 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) ---> (OFFSET1 cmp OFFSET2)
994 Value *L = EmitGEPOffset(GEPLHS);
995 Value *R = EmitGEPOffset(GEPRHS);
996 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R);
997 }
998 }
Silviu Barangaf29dfd32016-01-15 15:52:05 +0000999
1000 // Try convert this to an indexed compare by looking through PHIs/casts as a
1001 // last resort.
1002 return transformToIndexedCompare(GEPLHS, RHS, Cond, DL);
Chris Lattner2188e402010-01-04 07:37:31 +00001003}
1004
Pete Cooper980a9352016-08-12 17:13:28 +00001005Instruction *InstCombiner::foldAllocaCmp(ICmpInst &ICI,
1006 const AllocaInst *Alloca,
1007 const Value *Other) {
Hans Wennborgf1f36512015-10-07 00:20:07 +00001008 assert(ICI.isEquality() && "Cannot fold non-equality comparison.");
1009
1010 // It would be tempting to fold away comparisons between allocas and any
1011 // pointer not based on that alloca (e.g. an argument). However, even
1012 // though such pointers cannot alias, they can still compare equal.
1013 //
1014 // But LLVM doesn't specify where allocas get their memory, so if the alloca
1015 // doesn't escape we can argue that it's impossible to guess its value, and we
1016 // can therefore act as if any such guesses are wrong.
1017 //
1018 // The code below checks that the alloca doesn't escape, and that it's only
1019 // used in a comparison once (the current instruction). The
1020 // single-comparison-use condition ensures that we're trivially folding all
1021 // comparisons against the alloca consistently, and avoids the risk of
1022 // erroneously folding a comparison of the pointer with itself.
1023
1024 unsigned MaxIter = 32; // Break cycles and bound to constant-time.
1025
Pete Cooper980a9352016-08-12 17:13:28 +00001026 SmallVector<const Use *, 32> Worklist;
1027 for (const Use &U : Alloca->uses()) {
Hans Wennborgf1f36512015-10-07 00:20:07 +00001028 if (Worklist.size() >= MaxIter)
1029 return nullptr;
1030 Worklist.push_back(&U);
1031 }
1032
1033 unsigned NumCmps = 0;
1034 while (!Worklist.empty()) {
1035 assert(Worklist.size() <= MaxIter);
Pete Cooper980a9352016-08-12 17:13:28 +00001036 const Use *U = Worklist.pop_back_val();
1037 const Value *V = U->getUser();
Hans Wennborgf1f36512015-10-07 00:20:07 +00001038 --MaxIter;
1039
1040 if (isa<BitCastInst>(V) || isa<GetElementPtrInst>(V) || isa<PHINode>(V) ||
1041 isa<SelectInst>(V)) {
1042 // Track the uses.
1043 } else if (isa<LoadInst>(V)) {
1044 // Loading from the pointer doesn't escape it.
1045 continue;
Pete Cooper980a9352016-08-12 17:13:28 +00001046 } else if (const auto *SI = dyn_cast<StoreInst>(V)) {
Hans Wennborgf1f36512015-10-07 00:20:07 +00001047 // Storing *to* the pointer is fine, but storing the pointer escapes it.
1048 if (SI->getValueOperand() == U->get())
1049 return nullptr;
1050 continue;
1051 } else if (isa<ICmpInst>(V)) {
1052 if (NumCmps++)
1053 return nullptr; // Found more than one cmp.
1054 continue;
Pete Cooper980a9352016-08-12 17:13:28 +00001055 } else if (const auto *Intrin = dyn_cast<IntrinsicInst>(V)) {
Hans Wennborgf1f36512015-10-07 00:20:07 +00001056 switch (Intrin->getIntrinsicID()) {
1057 // These intrinsics don't escape or compare the pointer. Memset is safe
1058 // because we don't allow ptrtoint. Memcpy and memmove are safe because
1059 // we don't allow stores, so src cannot point to V.
1060 case Intrinsic::lifetime_start: case Intrinsic::lifetime_end:
Hans Wennborgf1f36512015-10-07 00:20:07 +00001061 case Intrinsic::memcpy: case Intrinsic::memmove: case Intrinsic::memset:
1062 continue;
1063 default:
1064 return nullptr;
1065 }
1066 } else {
1067 return nullptr;
1068 }
Pete Cooper980a9352016-08-12 17:13:28 +00001069 for (const Use &U : V->uses()) {
Hans Wennborgf1f36512015-10-07 00:20:07 +00001070 if (Worklist.size() >= MaxIter)
1071 return nullptr;
1072 Worklist.push_back(&U);
1073 }
1074 }
1075
1076 Type *CmpTy = CmpInst::makeCmpResultType(Other->getType());
Sanjay Patel4b198802016-02-01 22:23:39 +00001077 return replaceInstUsesWith(
Hans Wennborgf1f36512015-10-07 00:20:07 +00001078 ICI,
1079 ConstantInt::get(CmpTy, !CmpInst::isTrueWhenEqual(ICI.getPredicate())));
1080}
1081
Craig Topperbee74792018-08-20 23:04:25 +00001082/// Fold "icmp pred (X+C), X".
1083Instruction *InstCombiner::foldICmpAddOpConst(Value *X, const APInt &C,
Sanjay Patel43395062016-07-21 18:07:40 +00001084 ICmpInst::Predicate Pred) {
Chris Lattner2188e402010-01-04 07:37:31 +00001085 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +00001086 // so the values can never be equal. Similarly for all other "or equals"
Chris Lattner2188e402010-01-04 07:37:31 +00001087 // operators.
Craig Topperbee74792018-08-20 23:04:25 +00001088 assert(!!C && "C should not be zero!");
Jim Grosbach129c52a2011-09-30 18:09:53 +00001089
Chris Lattner8c92b572010-01-08 17:48:19 +00001090 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255
Chris Lattner2188e402010-01-04 07:37:31 +00001091 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253
1092 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0
1093 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
Craig Topperbee74792018-08-20 23:04:25 +00001094 Constant *R = ConstantInt::get(X->getType(),
1095 APInt::getMaxValue(C.getBitWidth()) - C);
Chris Lattner2188e402010-01-04 07:37:31 +00001096 return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
1097 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001098
Chris Lattner2188e402010-01-04 07:37:31 +00001099 // (X+1) >u X --> X <u (0-1) --> X != 255
1100 // (X+2) >u X --> X <u (0-2) --> X <u 254
1101 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0
Duncan Sandse5220012011-02-17 07:46:37 +00001102 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
Craig Topperbee74792018-08-20 23:04:25 +00001103 return new ICmpInst(ICmpInst::ICMP_ULT, X,
1104 ConstantInt::get(X->getType(), -C));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001105
Craig Topperbee74792018-08-20 23:04:25 +00001106 APInt SMax = APInt::getSignedMaxValue(C.getBitWidth());
Chris Lattner2188e402010-01-04 07:37:31 +00001107
1108 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127
1109 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125
1110 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0
1111 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1
1112 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126
1113 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127
Duncan Sandse5220012011-02-17 07:46:37 +00001114 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
Craig Topperbee74792018-08-20 23:04:25 +00001115 return new ICmpInst(ICmpInst::ICMP_SGT, X,
1116 ConstantInt::get(X->getType(), SMax - C));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001117
Chris Lattner2188e402010-01-04 07:37:31 +00001118 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127
1119 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126
1120 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
1121 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
1122 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126
1123 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128
Jim Grosbach129c52a2011-09-30 18:09:53 +00001124
Chris Lattner2188e402010-01-04 07:37:31 +00001125 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
Craig Topperbee74792018-08-20 23:04:25 +00001126 return new ICmpInst(ICmpInst::ICMP_SLT, X,
1127 ConstantInt::get(X->getType(), SMax - (C - 1)));
Chris Lattner2188e402010-01-04 07:37:31 +00001128}
1129
Sanjay Patel8da42cc2016-09-15 22:26:31 +00001130/// Handle "(icmp eq/ne (ashr/lshr AP2, A), AP1)" ->
1131/// (icmp eq/ne A, Log2(AP2/AP1)) ->
1132/// (icmp eq/ne A, Log2(AP2) - Log2(AP1)).
1133Instruction *InstCombiner::foldICmpShrConstConst(ICmpInst &I, Value *A,
1134 const APInt &AP1,
1135 const APInt &AP2) {
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001136 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1137
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001138 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1139 if (I.getPredicate() == I.ICMP_NE)
1140 Pred = CmpInst::getInversePredicate(Pred);
1141 return new ICmpInst(Pred, LHS, RHS);
1142 };
1143
David Majnemer2abb8182014-10-25 07:13:13 +00001144 // Don't bother doing any work for cases which InstSimplify handles.
Craig Topper73ba1c82017-06-07 07:40:37 +00001145 if (AP2.isNullValue())
David Majnemer2abb8182014-10-25 07:13:13 +00001146 return nullptr;
Sanjay Patel8da42cc2016-09-15 22:26:31 +00001147
1148 bool IsAShr = isa<AShrOperator>(I.getOperand(0));
David Majnemer2abb8182014-10-25 07:13:13 +00001149 if (IsAShr) {
1150 if (AP2.isAllOnesValue())
1151 return nullptr;
1152 if (AP2.isNegative() != AP1.isNegative())
1153 return nullptr;
1154 if (AP2.sgt(AP1))
1155 return nullptr;
1156 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001157
David Majnemerd2056022014-10-21 19:51:55 +00001158 if (!AP1)
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001159 // 'A' must be large enough to shift out the highest set bit.
1160 return getICmp(I.ICMP_UGT, A,
1161 ConstantInt::get(A->getType(), AP2.logBase2()));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001162
David Majnemerd2056022014-10-21 19:51:55 +00001163 if (AP1 == AP2)
1164 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001165
Andrea Di Biagio5b92b492014-09-17 11:32:31 +00001166 int Shift;
David Majnemerd2056022014-10-21 19:51:55 +00001167 if (IsAShr && AP1.isNegative())
David Majnemere5977eb2015-09-19 00:48:26 +00001168 Shift = AP1.countLeadingOnes() - AP2.countLeadingOnes();
Andrea Di Biagio5b92b492014-09-17 11:32:31 +00001169 else
David Majnemere5977eb2015-09-19 00:48:26 +00001170 Shift = AP1.countLeadingZeros() - AP2.countLeadingZeros();
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001171
David Majnemerd2056022014-10-21 19:51:55 +00001172 if (Shift > 0) {
David Majnemere5977eb2015-09-19 00:48:26 +00001173 if (IsAShr && AP1 == AP2.ashr(Shift)) {
1174 // There are multiple solutions if we are comparing against -1 and the LHS
David Majnemer47ce0b82015-09-19 00:48:31 +00001175 // of the ashr is not a power of two.
David Majnemere5977eb2015-09-19 00:48:26 +00001176 if (AP1.isAllOnesValue() && !AP2.isPowerOf2())
1177 return getICmp(I.ICMP_UGE, A, ConstantInt::get(A->getType(), Shift));
David Majnemerd2056022014-10-21 19:51:55 +00001178 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
David Majnemere5977eb2015-09-19 00:48:26 +00001179 } else if (AP1 == AP2.lshr(Shift)) {
1180 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1181 }
David Majnemerd2056022014-10-21 19:51:55 +00001182 }
Sanjay Patel524fcdf2016-09-15 19:04:55 +00001183
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001184 // Shifting const2 will never be equal to const1.
Sanjay Patel524fcdf2016-09-15 19:04:55 +00001185 // FIXME: This should always be handled by InstSimplify?
1186 auto *TorF = ConstantInt::get(I.getType(), I.getPredicate() == I.ICMP_NE);
1187 return replaceInstUsesWith(I, TorF);
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001188}
Chris Lattner2188e402010-01-04 07:37:31 +00001189
Sanjay Patel8da42cc2016-09-15 22:26:31 +00001190/// Handle "(icmp eq/ne (shl AP2, A), AP1)" ->
1191/// (icmp eq/ne A, TrailingZeros(AP1) - TrailingZeros(AP2)).
1192Instruction *InstCombiner::foldICmpShlConstConst(ICmpInst &I, Value *A,
1193 const APInt &AP1,
1194 const APInt &AP2) {
David Majnemer59939ac2014-10-19 08:23:08 +00001195 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1196
David Majnemer59939ac2014-10-19 08:23:08 +00001197 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1198 if (I.getPredicate() == I.ICMP_NE)
1199 Pred = CmpInst::getInversePredicate(Pred);
1200 return new ICmpInst(Pred, LHS, RHS);
1201 };
1202
David Majnemer2abb8182014-10-25 07:13:13 +00001203 // Don't bother doing any work for cases which InstSimplify handles.
Craig Topper73ba1c82017-06-07 07:40:37 +00001204 if (AP2.isNullValue())
David Majnemer2abb8182014-10-25 07:13:13 +00001205 return nullptr;
David Majnemer59939ac2014-10-19 08:23:08 +00001206
1207 unsigned AP2TrailingZeros = AP2.countTrailingZeros();
1208
1209 if (!AP1 && AP2TrailingZeros != 0)
Sanjay Patelaf91d1f2016-09-15 21:35:30 +00001210 return getICmp(
1211 I.ICMP_UGE, A,
1212 ConstantInt::get(A->getType(), AP2.getBitWidth() - AP2TrailingZeros));
David Majnemer59939ac2014-10-19 08:23:08 +00001213
1214 if (AP1 == AP2)
1215 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1216
1217 // Get the distance between the lowest bits that are set.
1218 int Shift = AP1.countTrailingZeros() - AP2TrailingZeros;
1219
1220 if (Shift > 0 && AP2.shl(Shift) == AP1)
1221 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1222
1223 // Shifting const2 will never be equal to const1.
Sanjay Patel524fcdf2016-09-15 19:04:55 +00001224 // FIXME: This should always be handled by InstSimplify?
1225 auto *TorF = ConstantInt::get(I.getType(), I.getPredicate() == I.ICMP_NE);
1226 return replaceInstUsesWith(I, TorF);
David Majnemer59939ac2014-10-19 08:23:08 +00001227}
1228
Sanjay Patel06b127a2016-09-15 14:37:50 +00001229/// The caller has matched a pattern of the form:
1230/// I = icmp ugt (add (add A, B), CI2), CI1
1231/// If this is of the form:
1232/// sum = a + b
1233/// if (sum+128 >u 255)
1234/// Then replace it with llvm.sadd.with.overflow.i8.
1235///
Sanjay Pateld93c4c02016-09-15 18:22:25 +00001236static Instruction *processUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
Sanjay Patel06b127a2016-09-15 14:37:50 +00001237 ConstantInt *CI2, ConstantInt *CI1,
1238 InstCombiner &IC) {
1239 // The transformation we're trying to do here is to transform this into an
1240 // llvm.sadd.with.overflow. To do this, we have to replace the original add
1241 // with a narrower add, and discard the add-with-constant that is part of the
1242 // range check (if we can't eliminate it, this isn't profitable).
1243
1244 // In order to eliminate the add-with-constant, the compare can be its only
1245 // use.
1246 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
1247 if (!AddWithCst->hasOneUse())
1248 return nullptr;
1249
1250 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
1251 if (!CI2->getValue().isPowerOf2())
1252 return nullptr;
1253 unsigned NewWidth = CI2->getValue().countTrailingZeros();
1254 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31)
1255 return nullptr;
1256
1257 // The width of the new add formed is 1 more than the bias.
1258 ++NewWidth;
1259
1260 // Check to see that CI1 is an all-ones value with NewWidth bits.
1261 if (CI1->getBitWidth() == NewWidth ||
1262 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
1263 return nullptr;
1264
1265 // This is only really a signed overflow check if the inputs have been
1266 // sign-extended; check for that condition. For example, if CI2 is 2^31 and
1267 // the operands of the add are 64 bits wide, we need at least 33 sign bits.
1268 unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
1269 if (IC.ComputeNumSignBits(A, 0, &I) < NeededSignBits ||
1270 IC.ComputeNumSignBits(B, 0, &I) < NeededSignBits)
1271 return nullptr;
1272
1273 // In order to replace the original add with a narrower
1274 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
1275 // and truncates that discard the high bits of the add. Verify that this is
1276 // the case.
1277 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
1278 for (User *U : OrigAdd->users()) {
1279 if (U == AddWithCst)
1280 continue;
1281
1282 // Only accept truncates for now. We would really like a nice recursive
1283 // predicate like SimplifyDemandedBits, but which goes downwards the use-def
1284 // chain to see which bits of a value are actually demanded. If the
1285 // original add had another add which was then immediately truncated, we
1286 // could still do the transformation.
1287 TruncInst *TI = dyn_cast<TruncInst>(U);
1288 if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth)
1289 return nullptr;
1290 }
1291
1292 // If the pattern matches, truncate the inputs to the narrower type and
1293 // use the sadd_with_overflow intrinsic to efficiently compute both the
1294 // result and the overflow bit.
1295 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
1296 Value *F = Intrinsic::getDeclaration(I.getModule(),
1297 Intrinsic::sadd_with_overflow, NewType);
1298
Craig Topperbb4069e2017-07-07 23:16:26 +00001299 InstCombiner::BuilderTy &Builder = IC.Builder;
Sanjay Patel06b127a2016-09-15 14:37:50 +00001300
1301 // Put the new code above the original add, in case there are any uses of the
1302 // add between the add and the compare.
Craig Topperbb4069e2017-07-07 23:16:26 +00001303 Builder.SetInsertPoint(OrigAdd);
Sanjay Patel06b127a2016-09-15 14:37:50 +00001304
Craig Topperbb4069e2017-07-07 23:16:26 +00001305 Value *TruncA = Builder.CreateTrunc(A, NewType, A->getName() + ".trunc");
1306 Value *TruncB = Builder.CreateTrunc(B, NewType, B->getName() + ".trunc");
1307 CallInst *Call = Builder.CreateCall(F, {TruncA, TruncB}, "sadd");
1308 Value *Add = Builder.CreateExtractValue(Call, 0, "sadd.result");
1309 Value *ZExt = Builder.CreateZExt(Add, OrigAdd->getType());
Sanjay Patel06b127a2016-09-15 14:37:50 +00001310
1311 // The inner add was the result of the narrow add, zero extended to the
1312 // wider type. Replace it with the result computed by the intrinsic.
1313 IC.replaceInstUsesWith(*OrigAdd, ZExt);
1314
1315 // The original icmp gets replaced with the overflow value.
1316 return ExtractValueInst::Create(Call, 1, "sadd.overflow");
1317}
1318
Nikolai Bozhenov0e7ebbc2017-10-16 09:19:21 +00001319// Handle (icmp sgt smin(PosA, B) 0) -> (icmp sgt B 0)
1320Instruction *InstCombiner::foldICmpWithZero(ICmpInst &Cmp) {
1321 CmpInst::Predicate Pred = Cmp.getPredicate();
1322 Value *X = Cmp.getOperand(0);
1323
1324 if (match(Cmp.getOperand(1), m_Zero()) && Pred == ICmpInst::ICMP_SGT) {
1325 Value *A, *B;
1326 SelectPatternResult SPR = matchSelectPattern(X, A, B);
1327 if (SPR.Flavor == SPF_SMIN) {
1328 if (isKnownPositive(A, DL, 0, &AC, &Cmp, &DT))
1329 return new ICmpInst(Pred, B, Cmp.getOperand(1));
1330 if (isKnownPositive(B, DL, 0, &AC, &Cmp, &DT))
1331 return new ICmpInst(Pred, A, Cmp.getOperand(1));
1332 }
1333 }
1334 return nullptr;
1335}
1336
Sanjay Patel06b127a2016-09-15 14:37:50 +00001337// Fold icmp Pred X, C.
Sanjay Patel97459832016-09-15 15:11:12 +00001338Instruction *InstCombiner::foldICmpWithConstant(ICmpInst &Cmp) {
1339 CmpInst::Predicate Pred = Cmp.getPredicate();
Sanjay Patel40c53ea2016-09-15 16:23:20 +00001340 Value *X = Cmp.getOperand(0);
Sanjay Patel06b127a2016-09-15 14:37:50 +00001341
Sanjay Patel40c53ea2016-09-15 16:23:20 +00001342 const APInt *C;
1343 if (!match(Cmp.getOperand(1), m_APInt(C)))
Sanjay Patel97459832016-09-15 15:11:12 +00001344 return nullptr;
Sanjay Patel06b127a2016-09-15 14:37:50 +00001345
Sanjay Patel97459832016-09-15 15:11:12 +00001346 Value *A = nullptr, *B = nullptr;
Sanjay Patel06b127a2016-09-15 14:37:50 +00001347
Sanjay Patel97459832016-09-15 15:11:12 +00001348 // Match the following pattern, which is a common idiom when writing
1349 // overflow-safe integer arithmetic functions. The source performs an addition
1350 // in wider type and explicitly checks for overflow using comparisons against
1351 // INT_MIN and INT_MAX. Simplify by using the sadd_with_overflow intrinsic.
1352 //
1353 // TODO: This could probably be generalized to handle other overflow-safe
1354 // operations if we worked out the formulas to compute the appropriate magic
1355 // constants.
1356 //
1357 // sum = a + b
1358 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8
1359 {
1360 ConstantInt *CI2; // I = icmp ugt (add (add A, B), CI2), CI
1361 if (Pred == ICmpInst::ICMP_UGT &&
1362 match(X, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
Sanjay Pateld93c4c02016-09-15 18:22:25 +00001363 if (Instruction *Res = processUGT_ADDCST_ADD(
Sanjay Patel40c53ea2016-09-15 16:23:20 +00001364 Cmp, A, B, CI2, cast<ConstantInt>(Cmp.getOperand(1)), *this))
Sanjay Patel97459832016-09-15 15:11:12 +00001365 return Res;
1366 }
Sanjay Patel06b127a2016-09-15 14:37:50 +00001367
Sanjay Patel40c53ea2016-09-15 16:23:20 +00001368 // FIXME: Use m_APInt to allow folds for splat constants.
1369 ConstantInt *CI = dyn_cast<ConstantInt>(Cmp.getOperand(1));
1370 if (!CI)
1371 return nullptr;
Sanjay Patel06b127a2016-09-15 14:37:50 +00001372
Sanjay Patel97459832016-09-15 15:11:12 +00001373 // Canonicalize icmp instructions based on dominating conditions.
1374 BasicBlock *Parent = Cmp.getParent();
1375 BasicBlock *Dom = Parent->getSinglePredecessor();
1376 auto *BI = Dom ? dyn_cast<BranchInst>(Dom->getTerminator()) : nullptr;
1377 ICmpInst::Predicate Pred2;
1378 BasicBlock *TrueBB, *FalseBB;
1379 ConstantInt *CI2;
1380 if (BI && match(BI, m_Br(m_ICmp(Pred2, m_Specific(X), m_ConstantInt(CI2)),
1381 TrueBB, FalseBB)) &&
1382 TrueBB != FalseBB) {
1383 ConstantRange CR =
1384 ConstantRange::makeAllowedICmpRegion(Pred, CI->getValue());
1385 ConstantRange DominatingCR =
1386 (Parent == TrueBB)
1387 ? ConstantRange::makeExactICmpRegion(Pred2, CI2->getValue())
1388 : ConstantRange::makeExactICmpRegion(
1389 CmpInst::getInversePredicate(Pred2), CI2->getValue());
1390 ConstantRange Intersection = DominatingCR.intersectWith(CR);
1391 ConstantRange Difference = DominatingCR.difference(CR);
1392 if (Intersection.isEmptySet())
Craig Topperbb4069e2017-07-07 23:16:26 +00001393 return replaceInstUsesWith(Cmp, Builder.getFalse());
Sanjay Patel97459832016-09-15 15:11:12 +00001394 if (Difference.isEmptySet())
Craig Topperbb4069e2017-07-07 23:16:26 +00001395 return replaceInstUsesWith(Cmp, Builder.getTrue());
Sanjay Patel06b127a2016-09-15 14:37:50 +00001396
Sanjay Patel97459832016-09-15 15:11:12 +00001397 // If this is a normal comparison, it demands all bits. If it is a sign
1398 // bit comparison, it only demands the sign bit.
1399 bool UnusedBit;
1400 bool IsSignBit = isSignBitCheck(Pred, CI->getValue(), UnusedBit);
1401
1402 // Canonicalizing a sign bit comparison that gets used in a branch,
1403 // pessimizes codegen by generating branch on zero instruction instead
1404 // of a test and branch. So we avoid canonicalizing in such situations
1405 // because test and branch instruction has better branch displacement
1406 // than compare and branch instruction.
Eric Christophera95aac32017-06-30 01:57:48 +00001407 if (Cmp.isEquality() || (IsSignBit && hasBranchUse(Cmp)))
1408 return nullptr;
1409
1410 if (auto *AI = Intersection.getSingleElement())
Craig Topperbb4069e2017-07-07 23:16:26 +00001411 return new ICmpInst(ICmpInst::ICMP_EQ, X, Builder.getInt(*AI));
Eric Christophera95aac32017-06-30 01:57:48 +00001412 if (auto *AD = Difference.getSingleElement())
Craig Topperbb4069e2017-07-07 23:16:26 +00001413 return new ICmpInst(ICmpInst::ICMP_NE, X, Builder.getInt(*AD));
Sanjay Patel06b127a2016-09-15 14:37:50 +00001414 }
1415
1416 return nullptr;
1417}
1418
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001419/// Fold icmp (trunc X, Y), C.
1420Instruction *InstCombiner::foldICmpTruncConstant(ICmpInst &Cmp,
Craig Topper524c44f2017-08-23 05:46:07 +00001421 TruncInst *Trunc,
Craig Topper8ed1aa92017-10-03 05:31:07 +00001422 const APInt &C) {
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001423 ICmpInst::Predicate Pred = Cmp.getPredicate();
1424 Value *X = Trunc->getOperand(0);
Craig Topper8ed1aa92017-10-03 05:31:07 +00001425 if (C.isOneValue() && C.getBitWidth() > 1) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001426 // icmp slt trunc(signum(V)) 1 --> icmp slt V, 1
1427 Value *V = nullptr;
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001428 if (Pred == ICmpInst::ICMP_SLT && match(X, m_Signum(m_Value(V))))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001429 return new ICmpInst(ICmpInst::ICMP_SLT, V,
1430 ConstantInt::get(V->getType(), 1));
1431 }
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001432
1433 if (Cmp.isEquality() && Trunc->hasOneUse()) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001434 // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1435 // of the high bits truncated out of x are known.
Sanjay Patel40e8ca42016-08-18 20:28:54 +00001436 unsigned DstBits = Trunc->getType()->getScalarSizeInBits(),
1437 SrcBits = X->getType()->getScalarSizeInBits();
Craig Topper8205a1a2017-05-24 16:53:07 +00001438 KnownBits Known = computeKnownBits(X, 0, &Cmp);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001439
1440 // If all the high bits are known, we can do this xform.
Craig Topperb45eabc2017-04-26 16:39:58 +00001441 if ((Known.Zero | Known.One).countLeadingOnes() >= SrcBits - DstBits) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001442 // Pull in the high bits from known-ones set.
Craig Topper8ed1aa92017-10-03 05:31:07 +00001443 APInt NewRHS = C.zext(SrcBits);
Craig Topperb45eabc2017-04-26 16:39:58 +00001444 NewRHS |= Known.One & APInt::getHighBitsSet(SrcBits, SrcBits - DstBits);
Sanjay Patel40e8ca42016-08-18 20:28:54 +00001445 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), NewRHS));
Sanjay Patela3f4f082016-08-16 17:54:36 +00001446 }
1447 }
Sanjay Patel5f4ce4e2016-08-18 20:25:16 +00001448
Sanjay Patela3f4f082016-08-16 17:54:36 +00001449 return nullptr;
1450}
1451
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001452/// Fold icmp (xor X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001453Instruction *InstCombiner::foldICmpXorConstant(ICmpInst &Cmp,
1454 BinaryOperator *Xor,
Craig Topper8ed1aa92017-10-03 05:31:07 +00001455 const APInt &C) {
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001456 Value *X = Xor->getOperand(0);
1457 Value *Y = Xor->getOperand(1);
Sanjay Pateldaffec912016-08-17 19:45:18 +00001458 const APInt *XorC;
Sanjay Patel4c5e60d2016-08-18 14:10:48 +00001459 if (!match(Y, m_APInt(XorC)))
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001460 return nullptr;
Sanjay Patela3f4f082016-08-16 17:54:36 +00001461
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001462 // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1463 // fold the xor.
1464 ICmpInst::Predicate Pred = Cmp.getPredicate();
Craig Topperdf63b962017-10-03 19:14:23 +00001465 bool TrueIfSigned = false;
1466 if (isSignBitCheck(Cmp.getPredicate(), C, TrueIfSigned)) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001467
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001468 // If the sign bit of the XorCst is not set, there is no change to
1469 // the operation, just stop using the Xor.
Sanjay Pateldaffec912016-08-17 19:45:18 +00001470 if (!XorC->isNegative()) {
1471 Cmp.setOperand(0, X);
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001472 Worklist.Add(Xor);
1473 return &Cmp;
Sanjay Patela3f4f082016-08-16 17:54:36 +00001474 }
1475
Craig Topperdf63b962017-10-03 19:14:23 +00001476 // Emit the opposite comparison.
1477 if (TrueIfSigned)
1478 return new ICmpInst(ICmpInst::ICMP_SGT, X,
1479 ConstantInt::getAllOnesValue(X->getType()));
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001480 else
Craig Topperdf63b962017-10-03 19:14:23 +00001481 return new ICmpInst(ICmpInst::ICMP_SLT, X,
1482 ConstantInt::getNullValue(X->getType()));
Sanjay Patela3f4f082016-08-16 17:54:36 +00001483 }
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001484
1485 if (Xor->hasOneUse()) {
Craig Topperbcfd2d12017-04-20 16:56:25 +00001486 // (icmp u/s (xor X SignMask), C) -> (icmp s/u X, (xor C SignMask))
1487 if (!Cmp.isEquality() && XorC->isSignMask()) {
Sanjay Pateldaffec912016-08-17 19:45:18 +00001488 Pred = Cmp.isSigned() ? Cmp.getUnsignedPredicate()
1489 : Cmp.getSignedPredicate();
Craig Topper8ed1aa92017-10-03 05:31:07 +00001490 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), C ^ *XorC));
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001491 }
1492
Craig Topperbcfd2d12017-04-20 16:56:25 +00001493 // (icmp u/s (xor X ~SignMask), C) -> (icmp s/u X, (xor C ~SignMask))
Sanjay Pateldaffec912016-08-17 19:45:18 +00001494 if (!Cmp.isEquality() && XorC->isMaxSignedValue()) {
1495 Pred = Cmp.isSigned() ? Cmp.getUnsignedPredicate()
1496 : Cmp.getSignedPredicate();
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001497 Pred = Cmp.getSwappedPredicate(Pred);
Craig Topper8ed1aa92017-10-03 05:31:07 +00001498 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), C ^ *XorC));
Sanjay Patel6d5f4482016-08-17 19:23:42 +00001499 }
1500 }
1501
Sanjay Patel26725bd2018-09-11 22:00:15 +00001502 // Mask constant magic can eliminate an 'xor' with unsigned compares.
1503 if (Pred == ICmpInst::ICMP_UGT) {
1504 // (xor X, ~C) >u C --> X <u ~C (when C+1 is a power of 2)
1505 if (*XorC == ~C && (C + 1).isPowerOf2())
1506 return new ICmpInst(ICmpInst::ICMP_ULT, X, Y);
1507 // (xor X, C) >u C --> X >u C (when C+1 is a power of 2)
1508 if (*XorC == C && (C + 1).isPowerOf2())
1509 return new ICmpInst(ICmpInst::ICMP_UGT, X, Y);
1510 }
1511 if (Pred == ICmpInst::ICMP_ULT) {
1512 // (xor X, -C) <u C --> X >u ~C (when C is a power of 2)
1513 if (*XorC == -C && C.isPowerOf2())
1514 return new ICmpInst(ICmpInst::ICMP_UGT, X,
1515 ConstantInt::get(X->getType(), ~C));
1516 // (xor X, C) <u C --> X >u ~C (when -C is a power of 2)
1517 if (*XorC == C && (-C).isPowerOf2())
1518 return new ICmpInst(ICmpInst::ICMP_UGT, X,
1519 ConstantInt::get(X->getType(), ~C));
1520 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00001521 return nullptr;
1522}
1523
Sanjay Patel14e0e182016-08-26 18:28:46 +00001524/// Fold icmp (and (sh X, Y), C2), C1.
1525Instruction *InstCombiner::foldICmpAndShift(ICmpInst &Cmp, BinaryOperator *And,
Craig Topper8ed1aa92017-10-03 05:31:07 +00001526 const APInt &C1, const APInt &C2) {
Sanjay Patel9b40f982016-09-07 22:33:03 +00001527 BinaryOperator *Shift = dyn_cast<BinaryOperator>(And->getOperand(0));
1528 if (!Shift || !Shift->isShift())
Sanjay Patelda9c5622016-08-26 17:15:22 +00001529 return nullptr;
Sanjay Patela3f4f082016-08-16 17:54:36 +00001530
Sanjay Patelda9c5622016-08-26 17:15:22 +00001531 // If this is: (X >> C3) & C2 != C1 (where any shift and any compare could
1532 // exist), turn it into (X & (C2 << C3)) != (C1 << C3). This happens a LOT in
1533 // code produced by the clang front-end, for bitfield access.
Sanjay Patelda9c5622016-08-26 17:15:22 +00001534 // This seemingly simple opportunity to fold away a shift turns out to be
1535 // rather complicated. See PR17827 for details.
Sanjay Patel9b40f982016-09-07 22:33:03 +00001536 unsigned ShiftOpcode = Shift->getOpcode();
1537 bool IsShl = ShiftOpcode == Instruction::Shl;
1538 const APInt *C3;
1539 if (match(Shift->getOperand(1), m_APInt(C3))) {
Sanjay Patelda9c5622016-08-26 17:15:22 +00001540 bool CanFold = false;
Craig Topper7a930922017-10-04 23:06:13 +00001541 if (ShiftOpcode == Instruction::Shl) {
Sanjay Patelda9c5622016-08-26 17:15:22 +00001542 // For a left shift, we can fold if the comparison is not signed. We can
1543 // also fold a signed comparison if the mask value and comparison value
1544 // are not negative. These constraints may not be obvious, but we can
1545 // prove that they are correct using an SMT solver.
Craig Topper8ed1aa92017-10-03 05:31:07 +00001546 if (!Cmp.isSigned() || (!C2.isNegative() && !C1.isNegative()))
Sanjay Patelda9c5622016-08-26 17:15:22 +00001547 CanFold = true;
Craig Topper7a930922017-10-04 23:06:13 +00001548 } else {
1549 bool IsAshr = ShiftOpcode == Instruction::AShr;
Sanjay Patelda9c5622016-08-26 17:15:22 +00001550 // For a logical right shift, we can fold if the comparison is not signed.
1551 // We can also fold a signed comparison if the shifted mask value and the
1552 // shifted comparison value are not negative. These constraints may not be
1553 // obvious, but we can prove that they are correct using an SMT solver.
Craig Topper7a930922017-10-04 23:06:13 +00001554 // For an arithmetic shift right we can do the same, if we ensure
1555 // the And doesn't use any bits being shifted in. Normally these would
1556 // be turned into lshr by SimplifyDemandedBits, but not if there is an
1557 // additional user.
1558 if (!IsAshr || (C2.shl(*C3).lshr(*C3) == C2)) {
1559 if (!Cmp.isSigned() ||
1560 (!C2.shl(*C3).isNegative() && !C1.shl(*C3).isNegative()))
1561 CanFold = true;
1562 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00001563 }
1564
Sanjay Patelda9c5622016-08-26 17:15:22 +00001565 if (CanFold) {
Craig Topper8ed1aa92017-10-03 05:31:07 +00001566 APInt NewCst = IsShl ? C1.lshr(*C3) : C1.shl(*C3);
Sanjay Patel9b40f982016-09-07 22:33:03 +00001567 APInt SameAsC1 = IsShl ? NewCst.shl(*C3) : NewCst.lshr(*C3);
Sanjay Patelda9c5622016-08-26 17:15:22 +00001568 // Check to see if we are shifting out any of the bits being compared.
Craig Topper8ed1aa92017-10-03 05:31:07 +00001569 if (SameAsC1 != C1) {
Sanjay Patelda9c5622016-08-26 17:15:22 +00001570 // If we shifted bits out, the fold is not going to work out. As a
1571 // special case, check to see if this means that the result is always
1572 // true or false now.
1573 if (Cmp.getPredicate() == ICmpInst::ICMP_EQ)
Sanjay Patel1c608f42016-09-08 16:54:02 +00001574 return replaceInstUsesWith(Cmp, ConstantInt::getFalse(Cmp.getType()));
Sanjay Patelda9c5622016-08-26 17:15:22 +00001575 if (Cmp.getPredicate() == ICmpInst::ICMP_NE)
Sanjay Patel1c608f42016-09-08 16:54:02 +00001576 return replaceInstUsesWith(Cmp, ConstantInt::getTrue(Cmp.getType()));
Sanjay Patela3f4f082016-08-16 17:54:36 +00001577 } else {
Sanjay Patel9b40f982016-09-07 22:33:03 +00001578 Cmp.setOperand(1, ConstantInt::get(And->getType(), NewCst));
Craig Topper8ed1aa92017-10-03 05:31:07 +00001579 APInt NewAndCst = IsShl ? C2.lshr(*C3) : C2.shl(*C3);
Sanjay Patel9b40f982016-09-07 22:33:03 +00001580 And->setOperand(1, ConstantInt::get(And->getType(), NewAndCst));
Sanjay Patelda9c5622016-08-26 17:15:22 +00001581 And->setOperand(0, Shift->getOperand(0));
1582 Worklist.Add(Shift); // Shift is dead.
1583 return &Cmp;
Sanjay Patela3f4f082016-08-16 17:54:36 +00001584 }
Sanjay Patelda9c5622016-08-26 17:15:22 +00001585 }
1586 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00001587
Sanjay Patelda9c5622016-08-26 17:15:22 +00001588 // Turn ((X >> Y) & C2) == 0 into (X & (C2 << Y)) == 0. The latter is
1589 // preferable because it allows the C2 << Y expression to be hoisted out of a
1590 // loop if Y is invariant and X is not.
Craig Topper8ed1aa92017-10-03 05:31:07 +00001591 if (Shift->hasOneUse() && C1.isNullValue() && Cmp.isEquality() &&
Sanjay Patelda9c5622016-08-26 17:15:22 +00001592 !Shift->isArithmeticShift() && !isa<Constant>(Shift->getOperand(0))) {
1593 // Compute C2 << Y.
Sanjay Patel9b40f982016-09-07 22:33:03 +00001594 Value *NewShift =
Craig Topperbb4069e2017-07-07 23:16:26 +00001595 IsShl ? Builder.CreateLShr(And->getOperand(1), Shift->getOperand(1))
1596 : Builder.CreateShl(And->getOperand(1), Shift->getOperand(1));
Sanjay Patela3f4f082016-08-16 17:54:36 +00001597
Sanjay Patelda9c5622016-08-26 17:15:22 +00001598 // Compute X & (C2 << Y).
Craig Topperbb4069e2017-07-07 23:16:26 +00001599 Value *NewAnd = Builder.CreateAnd(Shift->getOperand(0), NewShift);
Sanjay Patelda9c5622016-08-26 17:15:22 +00001600 Cmp.setOperand(0, NewAnd);
1601 return &Cmp;
1602 }
1603
Sanjay Patel14e0e182016-08-26 18:28:46 +00001604 return nullptr;
1605}
1606
1607/// Fold icmp (and X, C2), C1.
1608Instruction *InstCombiner::foldICmpAndConstConst(ICmpInst &Cmp,
1609 BinaryOperator *And,
Craig Topper8ed1aa92017-10-03 05:31:07 +00001610 const APInt &C1) {
Sanjay Patel6b490972016-09-04 14:32:15 +00001611 const APInt *C2;
1612 if (!match(And->getOperand(1), m_APInt(C2)))
Sanjay Patel14e0e182016-08-26 18:28:46 +00001613 return nullptr;
1614
Craig Topper8bf62212017-09-26 18:47:25 +00001615 if (!And->hasOneUse())
Sanjay Patel14e0e182016-08-26 18:28:46 +00001616 return nullptr;
1617
Sanjay Patel6b490972016-09-04 14:32:15 +00001618 // If the LHS is an 'and' of a truncate and we can widen the and/compare to
1619 // the input width without changing the value produced, eliminate the cast:
1620 //
1621 // icmp (and (trunc W), C2), C1 -> icmp (and W, C2'), C1'
1622 //
1623 // We can do this transformation if the constants do not have their sign bits
1624 // set or if it is an equality comparison. Extending a relational comparison
1625 // when we're checking the sign bit would not work.
1626 Value *W;
Craig Topper8bf62212017-09-26 18:47:25 +00001627 if (match(And->getOperand(0), m_OneUse(m_Trunc(m_Value(W)))) &&
Craig Topper8ed1aa92017-10-03 05:31:07 +00001628 (Cmp.isEquality() || (!C1.isNegative() && !C2->isNegative()))) {
Sanjay Patel6b490972016-09-04 14:32:15 +00001629 // TODO: Is this a good transform for vectors? Wider types may reduce
1630 // throughput. Should this transform be limited (even for scalars) by using
Sanjay Patel2217f752017-01-31 17:25:42 +00001631 // shouldChangeType()?
Sanjay Patel6b490972016-09-04 14:32:15 +00001632 if (!Cmp.getType()->isVectorTy()) {
1633 Type *WideType = W->getType();
1634 unsigned WideScalarBits = WideType->getScalarSizeInBits();
Craig Topper8ed1aa92017-10-03 05:31:07 +00001635 Constant *ZextC1 = ConstantInt::get(WideType, C1.zext(WideScalarBits));
Sanjay Patel6b490972016-09-04 14:32:15 +00001636 Constant *ZextC2 = ConstantInt::get(WideType, C2->zext(WideScalarBits));
Craig Topperbb4069e2017-07-07 23:16:26 +00001637 Value *NewAnd = Builder.CreateAnd(W, ZextC2, And->getName());
Sanjay Patel6b490972016-09-04 14:32:15 +00001638 return new ICmpInst(Cmp.getPredicate(), NewAnd, ZextC1);
Sanjay Patel14e0e182016-08-26 18:28:46 +00001639 }
1640 }
1641
Craig Topper8ed1aa92017-10-03 05:31:07 +00001642 if (Instruction *I = foldICmpAndShift(Cmp, And, C1, *C2))
Sanjay Patel14e0e182016-08-26 18:28:46 +00001643 return I;
1644
Sanjay Patelda9c5622016-08-26 17:15:22 +00001645 // (icmp pred (and (or (lshr A, B), A), 1), 0) -->
Sanjay Patel6b490972016-09-04 14:32:15 +00001646 // (icmp pred (and A, (or (shl 1, B), 1), 0))
Sanjay Patelda9c5622016-08-26 17:15:22 +00001647 //
1648 // iff pred isn't signed
Craig Topper8ed1aa92017-10-03 05:31:07 +00001649 if (!Cmp.isSigned() && C1.isNullValue() && And->getOperand(0)->hasOneUse() &&
Craig Topper73ba1c82017-06-07 07:40:37 +00001650 match(And->getOperand(1), m_One())) {
Sanjay Pateldef931e2016-09-07 20:50:44 +00001651 Constant *One = cast<Constant>(And->getOperand(1));
1652 Value *Or = And->getOperand(0);
Sanjay Patelda9c5622016-08-26 17:15:22 +00001653 Value *A, *B, *LShr;
Sanjay Pateldef931e2016-09-07 20:50:44 +00001654 if (match(Or, m_Or(m_Value(LShr), m_Value(A))) &&
1655 match(LShr, m_LShr(m_Specific(A), m_Value(B)))) {
1656 unsigned UsesRemoved = 0;
1657 if (And->hasOneUse())
1658 ++UsesRemoved;
1659 if (Or->hasOneUse())
1660 ++UsesRemoved;
1661 if (LShr->hasOneUse())
1662 ++UsesRemoved;
1663
1664 // Compute A & ((1 << B) | 1)
1665 Value *NewOr = nullptr;
1666 if (auto *C = dyn_cast<Constant>(B)) {
1667 if (UsesRemoved >= 1)
1668 NewOr = ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One);
1669 } else {
1670 if (UsesRemoved >= 3)
Craig Topperbb4069e2017-07-07 23:16:26 +00001671 NewOr = Builder.CreateOr(Builder.CreateShl(One, B, LShr->getName(),
1672 /*HasNUW=*/true),
1673 One, Or->getName());
Sanjay Pateldef931e2016-09-07 20:50:44 +00001674 }
1675 if (NewOr) {
Craig Topperbb4069e2017-07-07 23:16:26 +00001676 Value *NewAnd = Builder.CreateAnd(A, NewOr, And->getName());
Sanjay Pateldef931e2016-09-07 20:50:44 +00001677 Cmp.setOperand(0, NewAnd);
1678 return &Cmp;
Sanjay Patela3f4f082016-08-16 17:54:36 +00001679 }
1680 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00001681 }
Sanjay Patelda9c5622016-08-26 17:15:22 +00001682
Sanjay Pateld3c7bb282016-08-26 16:42:33 +00001683 return nullptr;
1684}
1685
1686/// Fold icmp (and X, Y), C.
1687Instruction *InstCombiner::foldICmpAndConstant(ICmpInst &Cmp,
1688 BinaryOperator *And,
Craig Topper8ed1aa92017-10-03 05:31:07 +00001689 const APInt &C) {
Sanjay Pateld3c7bb282016-08-26 16:42:33 +00001690 if (Instruction *I = foldICmpAndConstConst(Cmp, And, C))
1691 return I;
1692
Sanjay Patel5c5311f2016-08-28 18:18:00 +00001693 // TODO: These all require that Y is constant too, so refactor with the above.
Sanjay Patela3f4f082016-08-16 17:54:36 +00001694
Sanjay Patel5c5311f2016-08-28 18:18:00 +00001695 // Try to optimize things like "A[i] & 42 == 0" to index computations.
1696 Value *X = And->getOperand(0);
1697 Value *Y = And->getOperand(1);
1698 if (auto *LI = dyn_cast<LoadInst>(X))
1699 if (auto *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1700 if (auto *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001701 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
Sanjay Patel5c5311f2016-08-28 18:18:00 +00001702 !LI->isVolatile() && isa<ConstantInt>(Y)) {
1703 ConstantInt *C2 = cast<ConstantInt>(Y);
1704 if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, Cmp, C2))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001705 return Res;
1706 }
Sanjay Patel5c5311f2016-08-28 18:18:00 +00001707
1708 if (!Cmp.isEquality())
1709 return nullptr;
Sanjay Patela3f4f082016-08-16 17:54:36 +00001710
1711 // X & -C == -C -> X > u ~C
1712 // X & -C != -C -> X <= u ~C
1713 // iff C is a power of 2
Craig Topper8ed1aa92017-10-03 05:31:07 +00001714 if (Cmp.getOperand(1) == Y && (-C).isPowerOf2()) {
Sanjay Patel5c5311f2016-08-28 18:18:00 +00001715 auto NewPred = Cmp.getPredicate() == CmpInst::ICMP_EQ ? CmpInst::ICMP_UGT
1716 : CmpInst::ICMP_ULE;
1717 return new ICmpInst(NewPred, X, SubOne(cast<Constant>(Cmp.getOperand(1))));
1718 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00001719
Sanjay Patel5c5311f2016-08-28 18:18:00 +00001720 // (X & C2) == 0 -> (trunc X) >= 0
1721 // (X & C2) != 0 -> (trunc X) < 0
1722 // iff C2 is a power of 2 and it masks the sign bit of a legal integer type.
1723 const APInt *C2;
Craig Topper8ed1aa92017-10-03 05:31:07 +00001724 if (And->hasOneUse() && C.isNullValue() && match(Y, m_APInt(C2))) {
Sanjay Patel5c5311f2016-08-28 18:18:00 +00001725 int32_t ExactLogBase2 = C2->exactLogBase2();
1726 if (ExactLogBase2 != -1 && DL.isLegalInteger(ExactLogBase2 + 1)) {
1727 Type *NTy = IntegerType::get(Cmp.getContext(), ExactLogBase2 + 1);
1728 if (And->getType()->isVectorTy())
1729 NTy = VectorType::get(NTy, And->getType()->getVectorNumElements());
Craig Topperbb4069e2017-07-07 23:16:26 +00001730 Value *Trunc = Builder.CreateTrunc(X, NTy);
Sanjay Patel5c5311f2016-08-28 18:18:00 +00001731 auto NewPred = Cmp.getPredicate() == CmpInst::ICMP_EQ ? CmpInst::ICMP_SGE
1732 : CmpInst::ICMP_SLT;
1733 return new ICmpInst(NewPred, Trunc, Constant::getNullValue(NTy));
Sanjay Patela3f4f082016-08-16 17:54:36 +00001734 }
1735 }
Sanjay Patel5c5311f2016-08-28 18:18:00 +00001736
Sanjay Patela3f4f082016-08-16 17:54:36 +00001737 return nullptr;
1738}
1739
Sanjay Patel943e92e2016-08-17 16:30:43 +00001740/// Fold icmp (or X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001741Instruction *InstCombiner::foldICmpOrConstant(ICmpInst &Cmp, BinaryOperator *Or,
Craig Topper8ed1aa92017-10-03 05:31:07 +00001742 const APInt &C) {
Sanjay Patel943e92e2016-08-17 16:30:43 +00001743 ICmpInst::Predicate Pred = Cmp.getPredicate();
Craig Topper8ed1aa92017-10-03 05:31:07 +00001744 if (C.isOneValue()) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001745 // icmp slt signum(V) 1 --> icmp slt V, 1
1746 Value *V = nullptr;
Sanjay Patel943e92e2016-08-17 16:30:43 +00001747 if (Pred == ICmpInst::ICMP_SLT && match(Or, m_Signum(m_Value(V))))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001748 return new ICmpInst(ICmpInst::ICMP_SLT, V,
1749 ConstantInt::get(V->getType(), 1));
1750 }
1751
Sanjay Patel50c82c42017-04-05 17:57:05 +00001752 // X | C == C --> X <=u C
1753 // X | C != C --> X >u C
1754 // iff C+1 is a power of 2 (C is a bitmask of the low bits)
1755 if (Cmp.isEquality() && Cmp.getOperand(1) == Or->getOperand(1) &&
Craig Topper8ed1aa92017-10-03 05:31:07 +00001756 (C + 1).isPowerOf2()) {
Sanjay Patel50c82c42017-04-05 17:57:05 +00001757 Pred = (Pred == CmpInst::ICMP_EQ) ? CmpInst::ICMP_ULE : CmpInst::ICMP_UGT;
1758 return new ICmpInst(Pred, Or->getOperand(0), Or->getOperand(1));
1759 }
1760
Craig Topper8ed1aa92017-10-03 05:31:07 +00001761 if (!Cmp.isEquality() || !C.isNullValue() || !Or->hasOneUse())
Sanjay Patela3f4f082016-08-16 17:54:36 +00001762 return nullptr;
1763
1764 Value *P, *Q;
Sanjay Patel943e92e2016-08-17 16:30:43 +00001765 if (match(Or, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
Sanjay Patela3f4f082016-08-16 17:54:36 +00001766 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1767 // -> and (icmp eq P, null), (icmp eq Q, null).
Reid Klecknera871d382016-08-19 16:53:18 +00001768 Value *CmpP =
Craig Topperbb4069e2017-07-07 23:16:26 +00001769 Builder.CreateICmp(Pred, P, ConstantInt::getNullValue(P->getType()));
Reid Klecknera871d382016-08-19 16:53:18 +00001770 Value *CmpQ =
Craig Topperbb4069e2017-07-07 23:16:26 +00001771 Builder.CreateICmp(Pred, Q, ConstantInt::getNullValue(Q->getType()));
Sanjay Patel3f4db3e2017-07-14 15:09:49 +00001772 auto BOpc = Pred == CmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
1773 return BinaryOperator::Create(BOpc, CmpP, CmpQ);
1774 }
1775
1776 // Are we using xors to bitwise check for a pair of (in)equalities? Convert to
1777 // a shorter form that has more potential to be folded even further.
1778 Value *X1, *X2, *X3, *X4;
1779 if (match(Or->getOperand(0), m_OneUse(m_Xor(m_Value(X1), m_Value(X2)))) &&
1780 match(Or->getOperand(1), m_OneUse(m_Xor(m_Value(X3), m_Value(X4))))) {
1781 // ((X1 ^ X2) || (X3 ^ X4)) == 0 --> (X1 == X2) && (X3 == X4)
1782 // ((X1 ^ X2) || (X3 ^ X4)) != 0 --> (X1 != X2) || (X3 != X4)
1783 Value *Cmp12 = Builder.CreateICmp(Pred, X1, X2);
1784 Value *Cmp34 = Builder.CreateICmp(Pred, X3, X4);
1785 auto BOpc = Pred == CmpInst::ICMP_EQ ? Instruction::And : Instruction::Or;
1786 return BinaryOperator::Create(BOpc, Cmp12, Cmp34);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001787 }
Sanjay Patel943e92e2016-08-17 16:30:43 +00001788
Sanjay Patela3f4f082016-08-16 17:54:36 +00001789 return nullptr;
1790}
1791
Sanjay Patel63478072016-08-18 15:44:44 +00001792/// Fold icmp (mul X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001793Instruction *InstCombiner::foldICmpMulConstant(ICmpInst &Cmp,
1794 BinaryOperator *Mul,
Craig Topper8ed1aa92017-10-03 05:31:07 +00001795 const APInt &C) {
Sanjay Patel63478072016-08-18 15:44:44 +00001796 const APInt *MulC;
1797 if (!match(Mul->getOperand(1), m_APInt(MulC)))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001798 return nullptr;
1799
Sanjay Patel63478072016-08-18 15:44:44 +00001800 // If this is a test of the sign bit and the multiply is sign-preserving with
1801 // a constant operand, use the multiply LHS operand instead.
1802 ICmpInst::Predicate Pred = Cmp.getPredicate();
Craig Topper8ed1aa92017-10-03 05:31:07 +00001803 if (isSignTest(Pred, C) && Mul->hasNoSignedWrap()) {
Sanjay Patel63478072016-08-18 15:44:44 +00001804 if (MulC->isNegative())
1805 Pred = ICmpInst::getSwappedPredicate(Pred);
1806 return new ICmpInst(Pred, Mul->getOperand(0),
1807 Constant::getNullValue(Mul->getType()));
1808 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00001809
1810 return nullptr;
1811}
1812
Sanjay Patel98cd99d2016-08-18 21:28:30 +00001813/// Fold icmp (shl 1, Y), C.
1814static Instruction *foldICmpShlOne(ICmpInst &Cmp, Instruction *Shl,
Craig Topper8ed1aa92017-10-03 05:31:07 +00001815 const APInt &C) {
Sanjay Patel98cd99d2016-08-18 21:28:30 +00001816 Value *Y;
1817 if (!match(Shl, m_Shl(m_One(), m_Value(Y))))
1818 return nullptr;
1819
1820 Type *ShiftType = Shl->getType();
Craig Topper8ed1aa92017-10-03 05:31:07 +00001821 unsigned TypeBits = C.getBitWidth();
1822 bool CIsPowerOf2 = C.isPowerOf2();
Sanjay Patel98cd99d2016-08-18 21:28:30 +00001823 ICmpInst::Predicate Pred = Cmp.getPredicate();
1824 if (Cmp.isUnsigned()) {
1825 // (1 << Y) pred C -> Y pred Log2(C)
1826 if (!CIsPowerOf2) {
1827 // (1 << Y) < 30 -> Y <= 4
1828 // (1 << Y) <= 30 -> Y <= 4
1829 // (1 << Y) >= 30 -> Y > 4
1830 // (1 << Y) > 30 -> Y > 4
1831 if (Pred == ICmpInst::ICMP_ULT)
1832 Pred = ICmpInst::ICMP_ULE;
1833 else if (Pred == ICmpInst::ICMP_UGE)
1834 Pred = ICmpInst::ICMP_UGT;
1835 }
1836
1837 // (1 << Y) >= 2147483648 -> Y >= 31 -> Y == 31
1838 // (1 << Y) < 2147483648 -> Y < 31 -> Y != 31
Craig Topper8ed1aa92017-10-03 05:31:07 +00001839 unsigned CLog2 = C.logBase2();
Sanjay Patel98cd99d2016-08-18 21:28:30 +00001840 if (CLog2 == TypeBits - 1) {
1841 if (Pred == ICmpInst::ICMP_UGE)
1842 Pred = ICmpInst::ICMP_EQ;
1843 else if (Pred == ICmpInst::ICMP_ULT)
1844 Pred = ICmpInst::ICMP_NE;
1845 }
1846 return new ICmpInst(Pred, Y, ConstantInt::get(ShiftType, CLog2));
1847 } else if (Cmp.isSigned()) {
1848 Constant *BitWidthMinusOne = ConstantInt::get(ShiftType, TypeBits - 1);
Craig Topper8ed1aa92017-10-03 05:31:07 +00001849 if (C.isAllOnesValue()) {
Sanjay Patel98cd99d2016-08-18 21:28:30 +00001850 // (1 << Y) <= -1 -> Y == 31
1851 if (Pred == ICmpInst::ICMP_SLE)
1852 return new ICmpInst(ICmpInst::ICMP_EQ, Y, BitWidthMinusOne);
1853
1854 // (1 << Y) > -1 -> Y != 31
1855 if (Pred == ICmpInst::ICMP_SGT)
1856 return new ICmpInst(ICmpInst::ICMP_NE, Y, BitWidthMinusOne);
Craig Topper8ed1aa92017-10-03 05:31:07 +00001857 } else if (!C) {
Sanjay Patel98cd99d2016-08-18 21:28:30 +00001858 // (1 << Y) < 0 -> Y == 31
1859 // (1 << Y) <= 0 -> Y == 31
1860 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1861 return new ICmpInst(ICmpInst::ICMP_EQ, Y, BitWidthMinusOne);
1862
1863 // (1 << Y) >= 0 -> Y != 31
1864 // (1 << Y) > 0 -> Y != 31
1865 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
1866 return new ICmpInst(ICmpInst::ICMP_NE, Y, BitWidthMinusOne);
1867 }
1868 } else if (Cmp.isEquality() && CIsPowerOf2) {
Craig Topper8ed1aa92017-10-03 05:31:07 +00001869 return new ICmpInst(Pred, Y, ConstantInt::get(ShiftType, C.logBase2()));
Sanjay Patel98cd99d2016-08-18 21:28:30 +00001870 }
1871
1872 return nullptr;
1873}
1874
Sanjay Patel38b75062016-08-19 17:20:37 +00001875/// Fold icmp (shl X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001876Instruction *InstCombiner::foldICmpShlConstant(ICmpInst &Cmp,
1877 BinaryOperator *Shl,
Craig Topper8ed1aa92017-10-03 05:31:07 +00001878 const APInt &C) {
Sanjay Patel8da42cc2016-09-15 22:26:31 +00001879 const APInt *ShiftVal;
1880 if (Cmp.isEquality() && match(Shl->getOperand(0), m_APInt(ShiftVal)))
Craig Topper8ed1aa92017-10-03 05:31:07 +00001881 return foldICmpShlConstConst(Cmp, Shl->getOperand(1), C, *ShiftVal);
Sanjay Patel8da42cc2016-09-15 22:26:31 +00001882
Sanjay Patelfa7de602016-08-19 22:33:26 +00001883 const APInt *ShiftAmt;
1884 if (!match(Shl->getOperand(1), m_APInt(ShiftAmt)))
Sanjay Patel38b75062016-08-19 17:20:37 +00001885 return foldICmpShlOne(Cmp, Shl, C);
Sanjay Patela867afe2016-08-19 16:12:16 +00001886
Sanjay Patel38b75062016-08-19 17:20:37 +00001887 // Check that the shift amount is in range. If not, don't perform undefined
Sanjay Patel940c0612017-01-09 16:27:56 +00001888 // shifts. When the shift is visited, it will be simplified.
Craig Topper8ed1aa92017-10-03 05:31:07 +00001889 unsigned TypeBits = C.getBitWidth();
Sanjay Patelfa7de602016-08-19 22:33:26 +00001890 if (ShiftAmt->uge(TypeBits))
Sanjay Patela3f4f082016-08-16 17:54:36 +00001891 return nullptr;
1892
Sanjay Patele38e79c2016-08-19 17:34:05 +00001893 ICmpInst::Predicate Pred = Cmp.getPredicate();
1894 Value *X = Shl->getOperand(0);
Sanjay Patel14715b32017-01-17 21:25:16 +00001895 Type *ShType = Shl->getType();
1896
Sanjay Patel291c3d82017-01-19 16:12:10 +00001897 // NSW guarantees that we are only shifting out sign bits from the high bits,
1898 // so we can ASHR the compare constant without needing a mask and eliminate
1899 // the shift.
1900 if (Shl->hasNoSignedWrap()) {
1901 if (Pred == ICmpInst::ICMP_SGT) {
1902 // icmp Pred (shl nsw X, ShiftAmt), C --> icmp Pred X, (C >>s ShiftAmt)
Craig Topper8ed1aa92017-10-03 05:31:07 +00001903 APInt ShiftedC = C.ashr(*ShiftAmt);
Sanjay Patel291c3d82017-01-19 16:12:10 +00001904 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
1905 }
Sanjay Patel6fb13572018-01-09 18:56:03 +00001906 if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
1907 C.ashr(*ShiftAmt).shl(*ShiftAmt) == C) {
Craig Topper8ed1aa92017-10-03 05:31:07 +00001908 APInt ShiftedC = C.ashr(*ShiftAmt);
Sanjay Patel291c3d82017-01-19 16:12:10 +00001909 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
1910 }
1911 if (Pred == ICmpInst::ICMP_SLT) {
1912 // SLE is the same as above, but SLE is canonicalized to SLT, so convert:
1913 // (X << S) <=s C is equiv to X <=s (C >> S) for all C
1914 // (X << S) <s (C + 1) is equiv to X <s (C >> S) + 1 if C <s SMAX
1915 // (X << S) <s C is equiv to X <s ((C - 1) >> S) + 1 if C >s SMIN
Craig Topper8ed1aa92017-10-03 05:31:07 +00001916 assert(!C.isMinSignedValue() && "Unexpected icmp slt");
1917 APInt ShiftedC = (C - 1).ashr(*ShiftAmt) + 1;
Sanjay Patel291c3d82017-01-19 16:12:10 +00001918 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
1919 }
1920 // If this is a signed comparison to 0 and the shift is sign preserving,
1921 // use the shift LHS operand instead; isSignTest may change 'Pred', so only
1922 // do that if we're sure to not continue on in this function.
Craig Topper8ed1aa92017-10-03 05:31:07 +00001923 if (isSignTest(Pred, C))
Sanjay Patel291c3d82017-01-19 16:12:10 +00001924 return new ICmpInst(Pred, X, Constant::getNullValue(ShType));
1925 }
Sanjay Patel14715b32017-01-17 21:25:16 +00001926
Sanjay Patel291c3d82017-01-19 16:12:10 +00001927 // NUW guarantees that we are only shifting out zero bits from the high bits,
1928 // so we can LSHR the compare constant without needing a mask and eliminate
1929 // the shift.
Sanjay Patel14715b32017-01-17 21:25:16 +00001930 if (Shl->hasNoUnsignedWrap()) {
Sanjay Patelae23d652017-01-18 21:16:12 +00001931 if (Pred == ICmpInst::ICMP_UGT) {
Sanjay Patel14715b32017-01-17 21:25:16 +00001932 // icmp Pred (shl nuw X, ShiftAmt), C --> icmp Pred X, (C >>u ShiftAmt)
Craig Topper8ed1aa92017-10-03 05:31:07 +00001933 APInt ShiftedC = C.lshr(*ShiftAmt);
Sanjay Patel14715b32017-01-17 21:25:16 +00001934 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
1935 }
Sanjay Patel6fb13572018-01-09 18:56:03 +00001936 if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_NE) &&
1937 C.lshr(*ShiftAmt).shl(*ShiftAmt) == C) {
Craig Topper8ed1aa92017-10-03 05:31:07 +00001938 APInt ShiftedC = C.lshr(*ShiftAmt);
Sanjay Patelae23d652017-01-18 21:16:12 +00001939 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
1940 }
Sanjay Patel14715b32017-01-17 21:25:16 +00001941 if (Pred == ICmpInst::ICMP_ULT) {
1942 // ULE is the same as above, but ULE is canonicalized to ULT, so convert:
1943 // (X << S) <=u C is equiv to X <=u (C >> S) for all C
1944 // (X << S) <u (C + 1) is equiv to X <u (C >> S) + 1 if C <u ~0u
1945 // (X << S) <u C is equiv to X <u ((C - 1) >> S) + 1 if C >u 0
Craig Topper8ed1aa92017-10-03 05:31:07 +00001946 assert(C.ugt(0) && "ult 0 should have been eliminated");
1947 APInt ShiftedC = (C - 1).lshr(*ShiftAmt) + 1;
Sanjay Patel14715b32017-01-17 21:25:16 +00001948 return new ICmpInst(Pred, X, ConstantInt::get(ShType, ShiftedC));
1949 }
1950 }
1951
Sanjay Patel291c3d82017-01-19 16:12:10 +00001952 if (Cmp.isEquality() && Shl->hasOneUse()) {
1953 // Strength-reduce the shift into an 'and'.
1954 Constant *Mask = ConstantInt::get(
1955 ShType,
1956 APInt::getLowBitsSet(TypeBits, TypeBits - ShiftAmt->getZExtValue()));
Craig Topperbb4069e2017-07-07 23:16:26 +00001957 Value *And = Builder.CreateAnd(X, Mask, Shl->getName() + ".mask");
Craig Topper8ed1aa92017-10-03 05:31:07 +00001958 Constant *LShrC = ConstantInt::get(ShType, C.lshr(*ShiftAmt));
Sanjay Patel291c3d82017-01-19 16:12:10 +00001959 return new ICmpInst(Pred, And, LShrC);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001960 }
1961
Sanjay Patela3f4f082016-08-16 17:54:36 +00001962 // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
1963 bool TrueIfSigned = false;
Craig Topper8ed1aa92017-10-03 05:31:07 +00001964 if (Shl->hasOneUse() && isSignBitCheck(Pred, C, TrueIfSigned)) {
Sanjay Patel7ffcde72016-08-21 16:35:34 +00001965 // (X << 31) <s 0 --> (X & 1) != 0
Sanjay Patela3f4f082016-08-16 17:54:36 +00001966 Constant *Mask = ConstantInt::get(
Sanjay Patel14715b32017-01-17 21:25:16 +00001967 ShType,
Sanjay Patelfa7de602016-08-19 22:33:26 +00001968 APInt::getOneBitSet(TypeBits, TypeBits - ShiftAmt->getZExtValue() - 1));
Craig Topperbb4069e2017-07-07 23:16:26 +00001969 Value *And = Builder.CreateAnd(X, Mask, Shl->getName() + ".mask");
Sanjay Patela3f4f082016-08-16 17:54:36 +00001970 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
Sanjay Patel14715b32017-01-17 21:25:16 +00001971 And, Constant::getNullValue(ShType));
Sanjay Patelc0339c72016-11-01 19:19:29 +00001972 }
1973
Sanjay Patel643d21a2016-08-21 17:10:07 +00001974 // Transform (icmp pred iM (shl iM %v, N), C)
1975 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (C>>N))
1976 // Transform the shl to a trunc if (trunc (C>>N)) has no loss and M-N.
Sanjay Patel940c0612017-01-09 16:27:56 +00001977 // This enables us to get rid of the shift in favor of a trunc that may be
Sanjay Patela3f4f082016-08-16 17:54:36 +00001978 // free on the target. It has the additional benefit of comparing to a
Sanjay Patel940c0612017-01-09 16:27:56 +00001979 // smaller constant that may be more target-friendly.
Sanjay Patelfa7de602016-08-19 22:33:26 +00001980 unsigned Amt = ShiftAmt->getLimitedValue(TypeBits - 1);
Craig Topper8ed1aa92017-10-03 05:31:07 +00001981 if (Shl->hasOneUse() && Amt != 0 && C.countTrailingZeros() >= Amt &&
Sanjay Patelf3dda132016-10-25 20:11:47 +00001982 DL.isLegalInteger(TypeBits - Amt)) {
Sanjay Patel643d21a2016-08-21 17:10:07 +00001983 Type *TruncTy = IntegerType::get(Cmp.getContext(), TypeBits - Amt);
Sanjay Patel14715b32017-01-17 21:25:16 +00001984 if (ShType->isVectorTy())
1985 TruncTy = VectorType::get(TruncTy, ShType->getVectorNumElements());
Sanjay Patel643d21a2016-08-21 17:10:07 +00001986 Constant *NewC =
Craig Topper8ed1aa92017-10-03 05:31:07 +00001987 ConstantInt::get(TruncTy, C.ashr(*ShiftAmt).trunc(TypeBits - Amt));
Craig Topperbb4069e2017-07-07 23:16:26 +00001988 return new ICmpInst(Pred, Builder.CreateTrunc(X, TruncTy), NewC);
Sanjay Patela3f4f082016-08-16 17:54:36 +00001989 }
1990
1991 return nullptr;
1992}
1993
Sanjay Patela3920492016-08-22 20:45:06 +00001994/// Fold icmp ({al}shr X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00001995Instruction *InstCombiner::foldICmpShrConstant(ICmpInst &Cmp,
1996 BinaryOperator *Shr,
Craig Topper8ed1aa92017-10-03 05:31:07 +00001997 const APInt &C) {
Sanjay Patela3920492016-08-22 20:45:06 +00001998 // An exact shr only shifts out zero bits, so:
1999 // icmp eq/ne (shr X, Y), 0 --> icmp eq/ne X, 0
Sanjay Pateld64e9882016-08-23 22:05:55 +00002000 Value *X = Shr->getOperand(0);
Sanjay Patelc9196c42016-08-22 21:24:29 +00002001 CmpInst::Predicate Pred = Cmp.getPredicate();
Craig Topper73ba1c82017-06-07 07:40:37 +00002002 if (Cmp.isEquality() && Shr->isExact() && Shr->hasOneUse() &&
Craig Topper8ed1aa92017-10-03 05:31:07 +00002003 C.isNullValue())
Sanjay Pateld64e9882016-08-23 22:05:55 +00002004 return new ICmpInst(Pred, X, Cmp.getOperand(1));
Sanjay Patela3920492016-08-22 20:45:06 +00002005
Sanjay Patel8da42cc2016-09-15 22:26:31 +00002006 const APInt *ShiftVal;
2007 if (Cmp.isEquality() && match(Shr->getOperand(0), m_APInt(ShiftVal)))
Craig Topper8ed1aa92017-10-03 05:31:07 +00002008 return foldICmpShrConstConst(Cmp, Shr->getOperand(1), C, *ShiftVal);
Sanjay Patel8da42cc2016-09-15 22:26:31 +00002009
Sanjay Pateld398d4a2016-08-24 22:22:06 +00002010 const APInt *ShiftAmt;
2011 if (!match(Shr->getOperand(1), m_APInt(ShiftAmt)))
Sanjay Patela3f4f082016-08-16 17:54:36 +00002012 return nullptr;
2013
Sanjay Pateld398d4a2016-08-24 22:22:06 +00002014 // Check that the shift amount is in range. If not, don't perform undefined
2015 // shifts. When the shift is visited it will be simplified.
Craig Topper8ed1aa92017-10-03 05:31:07 +00002016 unsigned TypeBits = C.getBitWidth();
Sanjay Pateld398d4a2016-08-24 22:22:06 +00002017 unsigned ShAmtVal = ShiftAmt->getLimitedValue(TypeBits);
Sanjay Pateldcac0df2016-08-23 21:25:13 +00002018 if (ShAmtVal >= TypeBits || ShAmtVal == 0)
2019 return nullptr;
2020
Sanjay Pateld64e9882016-08-23 22:05:55 +00002021 bool IsAShr = Shr->getOpcode() == Instruction::AShr;
Sanjay Patel7ac2db62017-10-05 21:11:49 +00002022 bool IsExact = Shr->isExact();
2023 Type *ShrTy = Shr->getType();
2024 // TODO: If we could guarantee that InstSimplify would handle all of the
2025 // constant-value-based preconditions in the folds below, then we could assert
2026 // those conditions rather than checking them. This is difficult because of
2027 // undef/poison (PR34838).
2028 if (IsAShr) {
2029 if (Pred == CmpInst::ICMP_SLT || (Pred == CmpInst::ICMP_SGT && IsExact)) {
2030 // icmp slt (ashr X, ShAmtC), C --> icmp slt X, (C << ShAmtC)
2031 // icmp sgt (ashr exact X, ShAmtC), C --> icmp sgt X, (C << ShAmtC)
2032 APInt ShiftedC = C.shl(ShAmtVal);
2033 if (ShiftedC.ashr(ShAmtVal) == C)
2034 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2035 }
2036 if (Pred == CmpInst::ICMP_SGT) {
2037 // icmp sgt (ashr X, ShAmtC), C --> icmp sgt X, ((C + 1) << ShAmtC) - 1
2038 APInt ShiftedC = (C + 1).shl(ShAmtVal) - 1;
2039 if (!C.isMaxSignedValue() && !(C + 1).shl(ShAmtVal).isMinSignedValue() &&
2040 (ShiftedC + 1).ashr(ShAmtVal) == (C + 1))
2041 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2042 }
2043 } else {
2044 if (Pred == CmpInst::ICMP_ULT || (Pred == CmpInst::ICMP_UGT && IsExact)) {
2045 // icmp ult (lshr X, ShAmtC), C --> icmp ult X, (C << ShAmtC)
2046 // icmp ugt (lshr exact X, ShAmtC), C --> icmp ugt X, (C << ShAmtC)
2047 APInt ShiftedC = C.shl(ShAmtVal);
2048 if (ShiftedC.lshr(ShAmtVal) == C)
2049 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2050 }
2051 if (Pred == CmpInst::ICMP_UGT) {
2052 // icmp ugt (lshr X, ShAmtC), C --> icmp ugt X, ((C + 1) << ShAmtC) - 1
2053 APInt ShiftedC = (C + 1).shl(ShAmtVal) - 1;
2054 if ((ShiftedC + 1).lshr(ShAmtVal) == (C + 1))
2055 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, ShiftedC));
2056 }
Sanjay Pateldcac0df2016-08-23 21:25:13 +00002057 }
2058
Sanjay Patel7ac2db62017-10-05 21:11:49 +00002059 if (!Cmp.isEquality())
2060 return nullptr;
2061
Sanjay Pateld398d4a2016-08-24 22:22:06 +00002062 // Handle equality comparisons of shift-by-constant.
2063
Sanjay Patel8e297742016-08-24 13:55:55 +00002064 // If the comparison constant changes with the shift, the comparison cannot
2065 // succeed (bits of the comparison constant cannot match the shifted value).
2066 // This should be known by InstSimplify and already be folded to true/false.
Craig Topper8ed1aa92017-10-03 05:31:07 +00002067 assert(((IsAShr && C.shl(ShAmtVal).ashr(ShAmtVal) == C) ||
2068 (!IsAShr && C.shl(ShAmtVal).lshr(ShAmtVal) == C)) &&
Sanjay Patel8e297742016-08-24 13:55:55 +00002069 "Expected icmp+shr simplify did not occur.");
2070
Sanjay Patel934738a2017-10-15 15:39:15 +00002071 // If the bits shifted out are known zero, compare the unshifted value:
Sanjay Pateldcac0df2016-08-23 21:25:13 +00002072 // (X & 4) >> 1 == 2 --> (X & 4) == 4.
Sanjay Patel934738a2017-10-15 15:39:15 +00002073 if (Shr->isExact())
Sanjay Patel42135be2017-10-16 14:47:24 +00002074 return new ICmpInst(Pred, X, ConstantInt::get(ShrTy, C << ShAmtVal));
Sanjay Patelf11b5b42017-10-05 14:26:15 +00002075
Sanjay Patel934738a2017-10-15 15:39:15 +00002076 if (Shr->hasOneUse()) {
2077 // Canonicalize the shift into an 'and':
2078 // icmp eq/ne (shr X, ShAmt), C --> icmp eq/ne (and X, HiMask), (C << ShAmt)
Sanjay Pateld398d4a2016-08-24 22:22:06 +00002079 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
Sanjay Patel7ac2db62017-10-05 21:11:49 +00002080 Constant *Mask = ConstantInt::get(ShrTy, Val);
Craig Topperbb4069e2017-07-07 23:16:26 +00002081 Value *And = Builder.CreateAnd(X, Mask, Shr->getName() + ".mask");
Sanjay Patel42135be2017-10-16 14:47:24 +00002082 return new ICmpInst(Pred, And, ConstantInt::get(ShrTy, C << ShAmtVal));
Sanjay Pateldcac0df2016-08-23 21:25:13 +00002083 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00002084
2085 return nullptr;
2086}
2087
Sanjay Patel12a41052016-08-18 17:37:26 +00002088/// Fold icmp (udiv X, Y), C.
2089Instruction *InstCombiner::foldICmpUDivConstant(ICmpInst &Cmp,
Sanjay Patelc9196c42016-08-22 21:24:29 +00002090 BinaryOperator *UDiv,
Craig Topper8ed1aa92017-10-03 05:31:07 +00002091 const APInt &C) {
Sanjay Patelfa5ca2b2016-08-18 17:55:59 +00002092 const APInt *C2;
2093 if (!match(UDiv->getOperand(0), m_APInt(C2)))
2094 return nullptr;
2095
Craig Topper29c282e2017-06-07 07:40:29 +00002096 assert(*C2 != 0 && "udiv 0, X should have been simplified already.");
Sanjay Patelfa5ca2b2016-08-18 17:55:59 +00002097
2098 // (icmp ugt (udiv C2, Y), C) -> (icmp ule Y, C2/(C+1))
2099 Value *Y = UDiv->getOperand(1);
2100 if (Cmp.getPredicate() == ICmpInst::ICMP_UGT) {
Craig Topper8ed1aa92017-10-03 05:31:07 +00002101 assert(!C.isMaxValue() &&
Sanjay Patelfa5ca2b2016-08-18 17:55:59 +00002102 "icmp ugt X, UINT_MAX should have been simplified already.");
2103 return new ICmpInst(ICmpInst::ICMP_ULE, Y,
Craig Topper8ed1aa92017-10-03 05:31:07 +00002104 ConstantInt::get(Y->getType(), C2->udiv(C + 1)));
Sanjay Patelfa5ca2b2016-08-18 17:55:59 +00002105 }
2106
2107 // (icmp ult (udiv C2, Y), C) -> (icmp ugt Y, C2/C)
2108 if (Cmp.getPredicate() == ICmpInst::ICMP_ULT) {
Craig Topper8ed1aa92017-10-03 05:31:07 +00002109 assert(C != 0 && "icmp ult X, 0 should have been simplified already.");
Sanjay Patelfa5ca2b2016-08-18 17:55:59 +00002110 return new ICmpInst(ICmpInst::ICMP_UGT, Y,
Craig Topper8ed1aa92017-10-03 05:31:07 +00002111 ConstantInt::get(Y->getType(), C2->udiv(C)));
Sanjay Patela3f4f082016-08-16 17:54:36 +00002112 }
2113
2114 return nullptr;
2115}
2116
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002117/// Fold icmp ({su}div X, Y), C.
2118Instruction *InstCombiner::foldICmpDivConstant(ICmpInst &Cmp,
2119 BinaryOperator *Div,
Craig Topper8ed1aa92017-10-03 05:31:07 +00002120 const APInt &C) {
Sanjay Patela7cb4772016-08-30 17:10:49 +00002121 // Fold: icmp pred ([us]div X, C2), C -> range test
Sanjay Patela3f4f082016-08-16 17:54:36 +00002122 // Fold this div into the comparison, producing a range check.
2123 // Determine, based on the divide type, what the range is being
2124 // checked. If there is an overflow on the low or high side, remember
2125 // it, otherwise compute the range [low, hi) bounding the new value.
2126 // See: InsertRangeTest above for the kinds of replacements possible.
Sanjay Patela7cb4772016-08-30 17:10:49 +00002127 const APInt *C2;
2128 if (!match(Div->getOperand(1), m_APInt(C2)))
Sanjay Patel16554142016-08-24 23:03:36 +00002129 return nullptr;
2130
Sanjay Patel16554142016-08-24 23:03:36 +00002131 // FIXME: If the operand types don't match the type of the divide
2132 // then don't attempt this transform. The code below doesn't have the
2133 // logic to deal with a signed divide and an unsigned compare (and
Sanjay Patela7cb4772016-08-30 17:10:49 +00002134 // vice versa). This is because (x /s C2) <s C produces different
2135 // results than (x /s C2) <u C or (x /u C2) <s C or even
2136 // (x /u C2) <u C. Simply casting the operands and result won't
Sanjay Patel16554142016-08-24 23:03:36 +00002137 // work. :( The if statement below tests that condition and bails
2138 // if it finds it.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002139 bool DivIsSigned = Div->getOpcode() == Instruction::SDiv;
2140 if (!Cmp.isEquality() && DivIsSigned != Cmp.isSigned())
Sanjay Patel16554142016-08-24 23:03:36 +00002141 return nullptr;
Sanjay Patela7cb4772016-08-30 17:10:49 +00002142
Sanjay Pateleea2ef72016-09-05 23:38:22 +00002143 // The ProdOV computation fails on divide by 0 and divide by -1. Cases with
2144 // INT_MIN will also fail if the divisor is 1. Although folds of all these
2145 // division-by-constant cases should be present, we can not assert that they
2146 // have happened before we reach this icmp instruction.
Craig Topper73ba1c82017-06-07 07:40:37 +00002147 if (C2->isNullValue() || C2->isOneValue() ||
2148 (DivIsSigned && C2->isAllOnesValue()))
Sanjay Pateleea2ef72016-09-05 23:38:22 +00002149 return nullptr;
Sanjay Patelb3714572016-08-30 17:31:34 +00002150
Craig Topper6e025a32017-10-01 23:53:54 +00002151 // Compute Prod = C * C2. We are essentially solving an equation of
2152 // form X / C2 = C. We solve for X by multiplying C2 and C.
Sanjay Patel541aef42016-08-31 21:57:21 +00002153 // By solving for X, we can turn this into a range check instead of computing
2154 // a divide.
Craig Topper8ed1aa92017-10-03 05:31:07 +00002155 APInt Prod = C * *C2;
Sanjay Patel16554142016-08-24 23:03:36 +00002156
Sanjay Patel541aef42016-08-31 21:57:21 +00002157 // Determine if the product overflows by seeing if the product is not equal to
2158 // the divide. Make sure we do the same kind of divide as in the LHS
2159 // instruction that we're folding.
Craig Topper8ed1aa92017-10-03 05:31:07 +00002160 bool ProdOV = (DivIsSigned ? Prod.sdiv(*C2) : Prod.udiv(*C2)) != C;
Sanjay Patel16554142016-08-24 23:03:36 +00002161
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002162 ICmpInst::Predicate Pred = Cmp.getPredicate();
Sanjay Patel16554142016-08-24 23:03:36 +00002163
2164 // If the division is known to be exact, then there is no remainder from the
2165 // divide, so the covered range size is unit, otherwise it is the divisor.
Craig Topper6e025a32017-10-01 23:53:54 +00002166 APInt RangeSize = Div->isExact() ? APInt(C2->getBitWidth(), 1) : *C2;
Sanjay Patel16554142016-08-24 23:03:36 +00002167
2168 // Figure out the interval that is being checked. For example, a comparison
2169 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
2170 // Compute this interval based on the constants involved and the signedness of
2171 // the compare/divide. This computes a half-open interval, keeping track of
2172 // whether either value in the interval overflows. After analysis each
2173 // overflow variable is set to 0 if it's corresponding bound variable is valid
2174 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
2175 int LoOverflow = 0, HiOverflow = 0;
Craig Topper6e025a32017-10-01 23:53:54 +00002176 APInt LoBound, HiBound;
Sanjay Patel16554142016-08-24 23:03:36 +00002177
2178 if (!DivIsSigned) { // udiv
2179 // e.g. X/5 op 3 --> [15, 20)
2180 LoBound = Prod;
2181 HiOverflow = LoOverflow = ProdOV;
2182 if (!HiOverflow) {
2183 // If this is not an exact divide, then many values in the range collapse
2184 // to the same result value.
Sanjay Pateld93c4c02016-09-15 18:22:25 +00002185 HiOverflow = addWithOverflow(HiBound, LoBound, RangeSize, false);
Sanjay Patel16554142016-08-24 23:03:36 +00002186 }
Sanjay Patel541aef42016-08-31 21:57:21 +00002187 } else if (C2->isStrictlyPositive()) { // Divisor is > 0.
Craig Topper8ed1aa92017-10-03 05:31:07 +00002188 if (C.isNullValue()) { // (X / pos) op 0
Sanjay Patel16554142016-08-24 23:03:36 +00002189 // Can't overflow. e.g. X/2 op 0 --> [-1, 2)
Craig Topper6e025a32017-10-01 23:53:54 +00002190 LoBound = -(RangeSize - 1);
Sanjay Patel16554142016-08-24 23:03:36 +00002191 HiBound = RangeSize;
Craig Topper8ed1aa92017-10-03 05:31:07 +00002192 } else if (C.isStrictlyPositive()) { // (X / pos) op pos
Sanjay Patel16554142016-08-24 23:03:36 +00002193 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20)
2194 HiOverflow = LoOverflow = ProdOV;
2195 if (!HiOverflow)
Sanjay Pateld93c4c02016-09-15 18:22:25 +00002196 HiOverflow = addWithOverflow(HiBound, Prod, RangeSize, true);
Sanjay Patel16554142016-08-24 23:03:36 +00002197 } else { // (X / pos) op neg
2198 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14)
Craig Topper6e025a32017-10-01 23:53:54 +00002199 HiBound = Prod + 1;
Sanjay Patel16554142016-08-24 23:03:36 +00002200 LoOverflow = HiOverflow = ProdOV ? -1 : 0;
2201 if (!LoOverflow) {
Craig Topper6e025a32017-10-01 23:53:54 +00002202 APInt DivNeg = -RangeSize;
Sanjay Pateld93c4c02016-09-15 18:22:25 +00002203 LoOverflow = addWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
Sanjay Patel16554142016-08-24 23:03:36 +00002204 }
2205 }
Sanjay Patel541aef42016-08-31 21:57:21 +00002206 } else if (C2->isNegative()) { // Divisor is < 0.
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002207 if (Div->isExact())
Craig Topper6e025a32017-10-01 23:53:54 +00002208 RangeSize.negate();
Craig Topper8ed1aa92017-10-03 05:31:07 +00002209 if (C.isNullValue()) { // (X / neg) op 0
Sanjay Patel16554142016-08-24 23:03:36 +00002210 // e.g. X/-5 op 0 --> [-4, 5)
Craig Topper6e025a32017-10-01 23:53:54 +00002211 LoBound = RangeSize + 1;
2212 HiBound = -RangeSize;
2213 if (HiBound == *C2) { // -INTMIN = INTMIN
Sanjay Patel16554142016-08-24 23:03:36 +00002214 HiOverflow = 1; // [INTMIN+1, overflow)
Craig Topper6e025a32017-10-01 23:53:54 +00002215 HiBound = APInt(); // e.g. X/INTMIN = 0 --> X > INTMIN
Sanjay Patel16554142016-08-24 23:03:36 +00002216 }
Craig Topper8ed1aa92017-10-03 05:31:07 +00002217 } else if (C.isStrictlyPositive()) { // (X / neg) op pos
Sanjay Patel16554142016-08-24 23:03:36 +00002218 // e.g. X/-5 op 3 --> [-19, -14)
Craig Topper6e025a32017-10-01 23:53:54 +00002219 HiBound = Prod + 1;
Sanjay Patel16554142016-08-24 23:03:36 +00002220 HiOverflow = LoOverflow = ProdOV ? -1 : 0;
2221 if (!LoOverflow)
Sanjay Pateld93c4c02016-09-15 18:22:25 +00002222 LoOverflow = addWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
Sanjay Patel16554142016-08-24 23:03:36 +00002223 } else { // (X / neg) op neg
2224 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20)
2225 LoOverflow = HiOverflow = ProdOV;
2226 if (!HiOverflow)
Sanjay Pateld93c4c02016-09-15 18:22:25 +00002227 HiOverflow = subWithOverflow(HiBound, Prod, RangeSize, true);
Sanjay Patel16554142016-08-24 23:03:36 +00002228 }
2229
2230 // Dividing by a negative swaps the condition. LT <-> GT
2231 Pred = ICmpInst::getSwappedPredicate(Pred);
2232 }
2233
Sanjay Patelf7ba0892016-08-26 15:53:01 +00002234 Value *X = Div->getOperand(0);
Sanjay Patel16554142016-08-24 23:03:36 +00002235 switch (Pred) {
2236 default: llvm_unreachable("Unhandled icmp opcode!");
2237 case ICmpInst::ICMP_EQ:
2238 if (LoOverflow && HiOverflow)
Craig Topperbb4069e2017-07-07 23:16:26 +00002239 return replaceInstUsesWith(Cmp, Builder.getFalse());
Sanjay Patel16554142016-08-24 23:03:36 +00002240 if (HiOverflow)
2241 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
Craig Topper6e025a32017-10-01 23:53:54 +00002242 ICmpInst::ICMP_UGE, X,
2243 ConstantInt::get(Div->getType(), LoBound));
Sanjay Patel16554142016-08-24 23:03:36 +00002244 if (LoOverflow)
2245 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
Craig Topper6e025a32017-10-01 23:53:54 +00002246 ICmpInst::ICMP_ULT, X,
2247 ConstantInt::get(Div->getType(), HiBound));
Sanjay Patel85d79742016-08-31 19:49:56 +00002248 return replaceInstUsesWith(
Craig Topper6e025a32017-10-01 23:53:54 +00002249 Cmp, insertRangeTest(X, LoBound, HiBound, DivIsSigned, true));
Sanjay Patel16554142016-08-24 23:03:36 +00002250 case ICmpInst::ICMP_NE:
2251 if (LoOverflow && HiOverflow)
Craig Topperbb4069e2017-07-07 23:16:26 +00002252 return replaceInstUsesWith(Cmp, Builder.getTrue());
Sanjay Patel16554142016-08-24 23:03:36 +00002253 if (HiOverflow)
2254 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
Craig Topper6e025a32017-10-01 23:53:54 +00002255 ICmpInst::ICMP_ULT, X,
2256 ConstantInt::get(Div->getType(), LoBound));
Sanjay Patel16554142016-08-24 23:03:36 +00002257 if (LoOverflow)
2258 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
Craig Topper6e025a32017-10-01 23:53:54 +00002259 ICmpInst::ICMP_UGE, X,
2260 ConstantInt::get(Div->getType(), HiBound));
Sanjay Patel541aef42016-08-31 21:57:21 +00002261 return replaceInstUsesWith(Cmp,
Craig Topper6e025a32017-10-01 23:53:54 +00002262 insertRangeTest(X, LoBound, HiBound,
Sanjay Patel541aef42016-08-31 21:57:21 +00002263 DivIsSigned, false));
Sanjay Patel16554142016-08-24 23:03:36 +00002264 case ICmpInst::ICMP_ULT:
2265 case ICmpInst::ICMP_SLT:
2266 if (LoOverflow == +1) // Low bound is greater than input range.
Craig Topperbb4069e2017-07-07 23:16:26 +00002267 return replaceInstUsesWith(Cmp, Builder.getTrue());
Sanjay Patel16554142016-08-24 23:03:36 +00002268 if (LoOverflow == -1) // Low bound is less than input range.
Craig Topperbb4069e2017-07-07 23:16:26 +00002269 return replaceInstUsesWith(Cmp, Builder.getFalse());
Craig Topper6e025a32017-10-01 23:53:54 +00002270 return new ICmpInst(Pred, X, ConstantInt::get(Div->getType(), LoBound));
Sanjay Patel16554142016-08-24 23:03:36 +00002271 case ICmpInst::ICMP_UGT:
2272 case ICmpInst::ICMP_SGT:
2273 if (HiOverflow == +1) // High bound greater than input range.
Craig Topperbb4069e2017-07-07 23:16:26 +00002274 return replaceInstUsesWith(Cmp, Builder.getFalse());
Sanjay Patel16554142016-08-24 23:03:36 +00002275 if (HiOverflow == -1) // High bound less than input range.
Craig Topperbb4069e2017-07-07 23:16:26 +00002276 return replaceInstUsesWith(Cmp, Builder.getTrue());
Sanjay Patel16554142016-08-24 23:03:36 +00002277 if (Pred == ICmpInst::ICMP_UGT)
Craig Topper6e025a32017-10-01 23:53:54 +00002278 return new ICmpInst(ICmpInst::ICMP_UGE, X,
2279 ConstantInt::get(Div->getType(), HiBound));
2280 return new ICmpInst(ICmpInst::ICMP_SGE, X,
2281 ConstantInt::get(Div->getType(), HiBound));
Sanjay Patel16554142016-08-24 23:03:36 +00002282 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00002283
2284 return nullptr;
2285}
2286
Sanjay Patelb9aa67b2016-08-16 21:26:10 +00002287/// Fold icmp (sub X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00002288Instruction *InstCombiner::foldICmpSubConstant(ICmpInst &Cmp,
2289 BinaryOperator *Sub,
Craig Topper8ed1aa92017-10-03 05:31:07 +00002290 const APInt &C) {
Sanjay Patel886a5422016-09-15 18:05:17 +00002291 Value *X = Sub->getOperand(0), *Y = Sub->getOperand(1);
2292 ICmpInst::Predicate Pred = Cmp.getPredicate();
2293
2294 // The following transforms are only worth it if the only user of the subtract
2295 // is the icmp.
2296 if (!Sub->hasOneUse())
Sanjay Patela3f4f082016-08-16 17:54:36 +00002297 return nullptr;
2298
Sanjay Patel886a5422016-09-15 18:05:17 +00002299 if (Sub->hasNoSignedWrap()) {
2300 // (icmp sgt (sub nsw X, Y), -1) -> (icmp sge X, Y)
Craig Topper8ed1aa92017-10-03 05:31:07 +00002301 if (Pred == ICmpInst::ICMP_SGT && C.isAllOnesValue())
Sanjay Patel886a5422016-09-15 18:05:17 +00002302 return new ICmpInst(ICmpInst::ICMP_SGE, X, Y);
Sanjay Patela3f4f082016-08-16 17:54:36 +00002303
Sanjay Patel886a5422016-09-15 18:05:17 +00002304 // (icmp sgt (sub nsw X, Y), 0) -> (icmp sgt X, Y)
Craig Topper8ed1aa92017-10-03 05:31:07 +00002305 if (Pred == ICmpInst::ICMP_SGT && C.isNullValue())
Sanjay Patel886a5422016-09-15 18:05:17 +00002306 return new ICmpInst(ICmpInst::ICMP_SGT, X, Y);
2307
2308 // (icmp slt (sub nsw X, Y), 0) -> (icmp slt X, Y)
Craig Topper8ed1aa92017-10-03 05:31:07 +00002309 if (Pred == ICmpInst::ICMP_SLT && C.isNullValue())
Sanjay Patel886a5422016-09-15 18:05:17 +00002310 return new ICmpInst(ICmpInst::ICMP_SLT, X, Y);
2311
2312 // (icmp slt (sub nsw X, Y), 1) -> (icmp sle X, Y)
Craig Topper8ed1aa92017-10-03 05:31:07 +00002313 if (Pred == ICmpInst::ICMP_SLT && C.isOneValue())
Sanjay Patel886a5422016-09-15 18:05:17 +00002314 return new ICmpInst(ICmpInst::ICMP_SLE, X, Y);
2315 }
2316
2317 const APInt *C2;
2318 if (!match(X, m_APInt(C2)))
2319 return nullptr;
2320
2321 // C2 - Y <u C -> (Y | (C - 1)) == C2
2322 // iff (C2 & (C - 1)) == C - 1 and C is a power of 2
Craig Topper8ed1aa92017-10-03 05:31:07 +00002323 if (Pred == ICmpInst::ICMP_ULT && C.isPowerOf2() &&
2324 (*C2 & (C - 1)) == (C - 1))
2325 return new ICmpInst(ICmpInst::ICMP_EQ, Builder.CreateOr(Y, C - 1), X);
Sanjay Patel886a5422016-09-15 18:05:17 +00002326
2327 // C2 - Y >u C -> (Y | C) != C2
2328 // iff C2 & C == C and C + 1 is a power of 2
Craig Topper8ed1aa92017-10-03 05:31:07 +00002329 if (Pred == ICmpInst::ICMP_UGT && (C + 1).isPowerOf2() && (*C2 & C) == C)
2330 return new ICmpInst(ICmpInst::ICMP_NE, Builder.CreateOr(Y, C), X);
Sanjay Patela3f4f082016-08-16 17:54:36 +00002331
2332 return nullptr;
2333}
2334
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002335/// Fold icmp (add X, Y), C.
Sanjay Patelc9196c42016-08-22 21:24:29 +00002336Instruction *InstCombiner::foldICmpAddConstant(ICmpInst &Cmp,
2337 BinaryOperator *Add,
Craig Topper8ed1aa92017-10-03 05:31:07 +00002338 const APInt &C) {
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002339 Value *Y = Add->getOperand(1);
2340 const APInt *C2;
2341 if (Cmp.isEquality() || !match(Y, m_APInt(C2)))
Sanjay Patela3f4f082016-08-16 17:54:36 +00002342 return nullptr;
2343
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002344 // Fold icmp pred (add X, C2), C.
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002345 Value *X = Add->getOperand(0);
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002346 Type *Ty = Add->getType();
Sanjay Patel6dd2eae2017-02-08 16:19:36 +00002347 CmpInst::Predicate Pred = Cmp.getPredicate();
Sanjay Patel45b7e692017-02-12 16:40:30 +00002348
Tim Northover12c1f762018-09-10 14:26:44 +00002349 if (!Add->hasOneUse())
2350 return nullptr;
2351
Sanjay Patel45b7e692017-02-12 16:40:30 +00002352 // If the add does not wrap, we can always adjust the compare by subtracting
Nicola Zaghen9588ad92018-09-04 10:29:48 +00002353 // the constants. Equality comparisons are handled elsewhere. SGE/SLE/UGE/ULE
2354 // are canonicalized to SGT/SLT/UGT/ULT.
2355 if ((Add->hasNoSignedWrap() &&
2356 (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLT)) ||
2357 (Add->hasNoUnsignedWrap() &&
2358 (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_ULT))) {
Sanjay Patel45b7e692017-02-12 16:40:30 +00002359 bool Overflow;
Nicola Zaghen9588ad92018-09-04 10:29:48 +00002360 APInt NewC =
2361 Cmp.isSigned() ? C.ssub_ov(*C2, Overflow) : C.usub_ov(*C2, Overflow);
Sanjay Patel45b7e692017-02-12 16:40:30 +00002362 // If there is overflow, the result must be true or false.
2363 // TODO: Can we assert there is no overflow because InstSimplify always
2364 // handles those cases?
2365 if (!Overflow)
2366 // icmp Pred (add nsw X, C2), C --> icmp Pred X, (C - C2)
2367 return new ICmpInst(Pred, X, ConstantInt::get(Ty, NewC));
2368 }
2369
Craig Topper8ed1aa92017-10-03 05:31:07 +00002370 auto CR = ConstantRange::makeExactICmpRegion(Pred, C).subtract(*C2);
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002371 const APInt &Upper = CR.getUpper();
2372 const APInt &Lower = CR.getLower();
2373 if (Cmp.isSigned()) {
Craig Topperbcfd2d12017-04-20 16:56:25 +00002374 if (Lower.isSignMask())
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002375 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantInt::get(Ty, Upper));
Craig Topperbcfd2d12017-04-20 16:56:25 +00002376 if (Upper.isSignMask())
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002377 return new ICmpInst(ICmpInst::ICMP_SGE, X, ConstantInt::get(Ty, Lower));
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002378 } else {
2379 if (Lower.isMinValue())
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002380 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantInt::get(Ty, Upper));
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002381 if (Upper.isMinValue())
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002382 return new ICmpInst(ICmpInst::ICMP_UGE, X, ConstantInt::get(Ty, Lower));
Sanjay Patel60ea1b42016-08-16 22:34:42 +00002383 }
Sanjay Patela3f4f082016-08-16 17:54:36 +00002384
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002385 // X+C <u C2 -> (X & -C2) == C
2386 // iff C & (C2-1) == 0
2387 // C2 is a power of 2
Craig Topper8ed1aa92017-10-03 05:31:07 +00002388 if (Pred == ICmpInst::ICMP_ULT && C.isPowerOf2() && (*C2 & (C - 1)) == 0)
2389 return new ICmpInst(ICmpInst::ICMP_EQ, Builder.CreateAnd(X, -C),
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002390 ConstantExpr::getNeg(cast<Constant>(Y)));
2391
2392 // X+C >u C2 -> (X & ~C2) != C
2393 // iff C & C2 == 0
2394 // C2+1 is a power of 2
Craig Topper8ed1aa92017-10-03 05:31:07 +00002395 if (Pred == ICmpInst::ICMP_UGT && (C + 1).isPowerOf2() && (*C2 & C) == 0)
2396 return new ICmpInst(ICmpInst::ICMP_NE, Builder.CreateAnd(X, ~C),
Sanjay Patel4f7eb2a2016-08-17 15:24:30 +00002397 ConstantExpr::getNeg(cast<Constant>(Y)));
2398
Sanjay Patela3f4f082016-08-16 17:54:36 +00002399 return nullptr;
2400}
2401
Anna Thomasd67165c2017-06-23 13:41:45 +00002402bool InstCombiner::matchThreeWayIntCompare(SelectInst *SI, Value *&LHS,
2403 Value *&RHS, ConstantInt *&Less,
2404 ConstantInt *&Equal,
2405 ConstantInt *&Greater) {
2406 // TODO: Generalize this to work with other comparison idioms or ensure
2407 // they get canonicalized into this form.
2408
2409 // select i1 (a == b), i32 Equal, i32 (select i1 (a < b), i32 Less, i32
2410 // Greater), where Equal, Less and Greater are placeholders for any three
2411 // constants.
2412 ICmpInst::Predicate PredA, PredB;
2413 if (match(SI->getTrueValue(), m_ConstantInt(Equal)) &&
2414 match(SI->getCondition(), m_ICmp(PredA, m_Value(LHS), m_Value(RHS))) &&
2415 PredA == ICmpInst::ICMP_EQ &&
2416 match(SI->getFalseValue(),
2417 m_Select(m_ICmp(PredB, m_Specific(LHS), m_Specific(RHS)),
2418 m_ConstantInt(Less), m_ConstantInt(Greater))) &&
2419 PredB == ICmpInst::ICMP_SLT) {
2420 return true;
2421 }
2422 return false;
2423}
2424
2425Instruction *InstCombiner::foldICmpSelectConstant(ICmpInst &Cmp,
Craig Topper524c44f2017-08-23 05:46:07 +00002426 SelectInst *Select,
Anna Thomasd67165c2017-06-23 13:41:45 +00002427 ConstantInt *C) {
2428
2429 assert(C && "Cmp RHS should be a constant int!");
2430 // If we're testing a constant value against the result of a three way
2431 // comparison, the result can be expressed directly in terms of the
2432 // original values being compared. Note: We could possibly be more
2433 // aggressive here and remove the hasOneUse test. The original select is
2434 // really likely to simplify or sink when we remove a test of the result.
2435 Value *OrigLHS, *OrigRHS;
2436 ConstantInt *C1LessThan, *C2Equal, *C3GreaterThan;
2437 if (Cmp.hasOneUse() &&
Craig Topper524c44f2017-08-23 05:46:07 +00002438 matchThreeWayIntCompare(Select, OrigLHS, OrigRHS, C1LessThan, C2Equal,
2439 C3GreaterThan)) {
Anna Thomasd67165c2017-06-23 13:41:45 +00002440 assert(C1LessThan && C2Equal && C3GreaterThan);
2441
2442 bool TrueWhenLessThan =
2443 ConstantExpr::getCompare(Cmp.getPredicate(), C1LessThan, C)
2444 ->isAllOnesValue();
2445 bool TrueWhenEqual =
2446 ConstantExpr::getCompare(Cmp.getPredicate(), C2Equal, C)
2447 ->isAllOnesValue();
2448 bool TrueWhenGreaterThan =
2449 ConstantExpr::getCompare(Cmp.getPredicate(), C3GreaterThan, C)
2450 ->isAllOnesValue();
2451
2452 // This generates the new instruction that will replace the original Cmp
2453 // Instruction. Instead of enumerating the various combinations when
2454 // TrueWhenLessThan, TrueWhenEqual and TrueWhenGreaterThan are true versus
2455 // false, we rely on chaining of ORs and future passes of InstCombine to
2456 // simplify the OR further (i.e. a s< b || a == b becomes a s<= b).
2457
2458 // When none of the three constants satisfy the predicate for the RHS (C),
2459 // the entire original Cmp can be simplified to a false.
Craig Topperbb4069e2017-07-07 23:16:26 +00002460 Value *Cond = Builder.getFalse();
Anna Thomasd67165c2017-06-23 13:41:45 +00002461 if (TrueWhenLessThan)
Craig Topperbb4069e2017-07-07 23:16:26 +00002462 Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_SLT, OrigLHS, OrigRHS));
Anna Thomasd67165c2017-06-23 13:41:45 +00002463 if (TrueWhenEqual)
Craig Topperbb4069e2017-07-07 23:16:26 +00002464 Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_EQ, OrigLHS, OrigRHS));
Anna Thomasd67165c2017-06-23 13:41:45 +00002465 if (TrueWhenGreaterThan)
Craig Topperbb4069e2017-07-07 23:16:26 +00002466 Cond = Builder.CreateOr(Cond, Builder.CreateICmp(ICmpInst::ICMP_SGT, OrigLHS, OrigRHS));
Anna Thomasd67165c2017-06-23 13:41:45 +00002467
2468 return replaceInstUsesWith(Cmp, Cond);
2469 }
2470 return nullptr;
2471}
2472
Daniel Neilson901acfa2018-04-03 17:26:20 +00002473Instruction *InstCombiner::foldICmpBitCastConstant(ICmpInst &Cmp,
2474 BitCastInst *Bitcast,
2475 const APInt &C) {
2476 // Folding: icmp <pred> iN X, C
2477 // where X = bitcast <M x iK> (shufflevector <M x iK> %vec, undef, SC)) to iN
2478 // and C is a splat of a K-bit pattern
2479 // and SC is a constant vector = <C', C', C', ..., C'>
2480 // Into:
2481 // %E = extractelement <M x iK> %vec, i32 C'
2482 // icmp <pred> iK %E, trunc(C)
2483 if (!Bitcast->getType()->isIntegerTy() ||
2484 !Bitcast->getSrcTy()->isIntOrIntVectorTy())
2485 return nullptr;
2486
2487 Value *BCIOp = Bitcast->getOperand(0);
2488 Value *Vec = nullptr; // 1st vector arg of the shufflevector
2489 Constant *Mask = nullptr; // Mask arg of the shufflevector
2490 if (match(BCIOp,
2491 m_ShuffleVector(m_Value(Vec), m_Undef(), m_Constant(Mask)))) {
2492 // Check whether every element of Mask is the same constant
2493 if (auto *Elem = dyn_cast_or_null<ConstantInt>(Mask->getSplatValue())) {
2494 auto *VecTy = cast<VectorType>(BCIOp->getType());
2495 auto *EltTy = cast<IntegerType>(VecTy->getElementType());
2496 auto Pred = Cmp.getPredicate();
2497 if (C.isSplat(EltTy->getBitWidth())) {
2498 // Fold the icmp based on the value of C
2499 // If C is M copies of an iK sized bit pattern,
2500 // then:
2501 // => %E = extractelement <N x iK> %vec, i32 Elem
2502 // icmp <pred> iK %SplatVal, <pattern>
2503 Value *Extract = Builder.CreateExtractElement(Vec, Elem);
2504 Value *NewC = ConstantInt::get(EltTy, C.trunc(EltTy->getBitWidth()));
2505 return new ICmpInst(Pred, Extract, NewC);
2506 }
2507 }
2508 }
2509 return nullptr;
2510}
2511
Sanjay Patelf58f68c2016-09-10 15:03:44 +00002512/// Try to fold integer comparisons with a constant operand: icmp Pred X, C
2513/// where X is some kind of instruction.
2514Instruction *InstCombiner::foldICmpInstWithConstant(ICmpInst &Cmp) {
Sanjay Patelc9196c42016-08-22 21:24:29 +00002515 const APInt *C;
2516 if (!match(Cmp.getOperand(1), m_APInt(C)))
Sanjay Patel1e5b2d12016-08-16 16:08:11 +00002517 return nullptr;
2518
Craig Toppera94069f2017-08-23 05:46:08 +00002519 if (auto *BO = dyn_cast<BinaryOperator>(Cmp.getOperand(0))) {
Sanjay Patelc9196c42016-08-22 21:24:29 +00002520 switch (BO->getOpcode()) {
2521 case Instruction::Xor:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002522 if (Instruction *I = foldICmpXorConstant(Cmp, BO, *C))
Sanjay Patelc9196c42016-08-22 21:24:29 +00002523 return I;
2524 break;
2525 case Instruction::And:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002526 if (Instruction *I = foldICmpAndConstant(Cmp, BO, *C))
Sanjay Patelc9196c42016-08-22 21:24:29 +00002527 return I;
2528 break;
2529 case Instruction::Or:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002530 if (Instruction *I = foldICmpOrConstant(Cmp, BO, *C))
Sanjay Patelc9196c42016-08-22 21:24:29 +00002531 return I;
2532 break;
2533 case Instruction::Mul:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002534 if (Instruction *I = foldICmpMulConstant(Cmp, BO, *C))
Sanjay Patelc9196c42016-08-22 21:24:29 +00002535 return I;
2536 break;
2537 case Instruction::Shl:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002538 if (Instruction *I = foldICmpShlConstant(Cmp, BO, *C))
Sanjay Patelc9196c42016-08-22 21:24:29 +00002539 return I;
2540 break;
2541 case Instruction::LShr:
2542 case Instruction::AShr:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002543 if (Instruction *I = foldICmpShrConstant(Cmp, BO, *C))
Sanjay Patelc9196c42016-08-22 21:24:29 +00002544 return I;
2545 break;
2546 case Instruction::UDiv:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002547 if (Instruction *I = foldICmpUDivConstant(Cmp, BO, *C))
Sanjay Patelc9196c42016-08-22 21:24:29 +00002548 return I;
2549 LLVM_FALLTHROUGH;
2550 case Instruction::SDiv:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002551 if (Instruction *I = foldICmpDivConstant(Cmp, BO, *C))
Sanjay Patelc9196c42016-08-22 21:24:29 +00002552 return I;
2553 break;
2554 case Instruction::Sub:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002555 if (Instruction *I = foldICmpSubConstant(Cmp, BO, *C))
Sanjay Patelc9196c42016-08-22 21:24:29 +00002556 return I;
2557 break;
2558 case Instruction::Add:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002559 if (Instruction *I = foldICmpAddConstant(Cmp, BO, *C))
Sanjay Patelc9196c42016-08-22 21:24:29 +00002560 return I;
2561 break;
2562 default:
2563 break;
2564 }
Sanjay Patelf58f68c2016-09-10 15:03:44 +00002565 // TODO: These folds could be refactored to be part of the above calls.
Craig Topper8ed1aa92017-10-03 05:31:07 +00002566 if (Instruction *I = foldICmpBinOpEqualityWithConstant(Cmp, BO, *C))
Sanjay Patelf58f68c2016-09-10 15:03:44 +00002567 return I;
Chris Lattner2188e402010-01-04 07:37:31 +00002568 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002569
Anna Thomasd67165c2017-06-23 13:41:45 +00002570 // Match against CmpInst LHS being instructions other than binary operators.
Craig Topper524c44f2017-08-23 05:46:07 +00002571
2572 if (auto *SI = dyn_cast<SelectInst>(Cmp.getOperand(0))) {
2573 // For now, we only support constant integers while folding the
2574 // ICMP(SELECT)) pattern. We can extend this to support vector of integers
2575 // similar to the cases handled by binary ops above.
2576 if (ConstantInt *ConstRHS = dyn_cast<ConstantInt>(Cmp.getOperand(1)))
2577 if (Instruction *I = foldICmpSelectConstant(Cmp, SI, ConstRHS))
Anna Thomasd67165c2017-06-23 13:41:45 +00002578 return I;
Craig Topper524c44f2017-08-23 05:46:07 +00002579 }
2580
2581 if (auto *TI = dyn_cast<TruncInst>(Cmp.getOperand(0))) {
Craig Topper8ed1aa92017-10-03 05:31:07 +00002582 if (Instruction *I = foldICmpTruncConstant(Cmp, TI, *C))
Craig Topper524c44f2017-08-23 05:46:07 +00002583 return I;
Anna Thomasd67165c2017-06-23 13:41:45 +00002584 }
Sanjay Patelc9196c42016-08-22 21:24:29 +00002585
Daniel Neilson901acfa2018-04-03 17:26:20 +00002586 if (auto *BCI = dyn_cast<BitCastInst>(Cmp.getOperand(0))) {
2587 if (Instruction *I = foldICmpBitCastConstant(Cmp, BCI, *C))
2588 return I;
2589 }
2590
Craig Topper8ed1aa92017-10-03 05:31:07 +00002591 if (Instruction *I = foldICmpIntrinsicWithConstant(Cmp, *C))
Sanjay Patelf58f68c2016-09-10 15:03:44 +00002592 return I;
2593
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002594 return nullptr;
2595}
Jim Grosbach129c52a2011-09-30 18:09:53 +00002596
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002597/// Fold an icmp equality instruction with binary operator LHS and constant RHS:
2598/// icmp eq/ne BO, C.
2599Instruction *InstCombiner::foldICmpBinOpEqualityWithConstant(ICmpInst &Cmp,
2600 BinaryOperator *BO,
Craig Topper8ed1aa92017-10-03 05:31:07 +00002601 const APInt &C) {
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002602 // TODO: Some of these folds could work with arbitrary constants, but this
2603 // function is limited to scalar and vector splat constants.
2604 if (!Cmp.isEquality())
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002605 return nullptr;
2606
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002607 ICmpInst::Predicate Pred = Cmp.getPredicate();
2608 bool isICMP_NE = Pred == ICmpInst::ICMP_NE;
2609 Constant *RHS = cast<Constant>(Cmp.getOperand(1));
Sanjay Patel51a767c2016-08-03 17:23:08 +00002610 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002611
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002612 switch (BO->getOpcode()) {
2613 case Instruction::SRem:
2614 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
Craig Topper8ed1aa92017-10-03 05:31:07 +00002615 if (C.isNullValue() && BO->hasOneUse()) {
Sanjay Patel2e9675f2016-08-03 19:48:40 +00002616 const APInt *BOC;
2617 if (match(BOp1, m_APInt(BOC)) && BOC->sgt(1) && BOC->isPowerOf2()) {
Craig Topperbb4069e2017-07-07 23:16:26 +00002618 Value *NewRem = Builder.CreateURem(BOp0, BOp1, BO->getName());
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002619 return new ICmpInst(Pred, NewRem,
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002620 Constant::getNullValue(BO->getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002621 }
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002622 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002623 break;
Sanjay Patel00a324e2016-08-03 22:08:44 +00002624 case Instruction::Add: {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002625 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
Sanjay Patel00a324e2016-08-03 22:08:44 +00002626 const APInt *BOC;
2627 if (match(BOp1, m_APInt(BOC))) {
2628 if (BO->hasOneUse()) {
2629 Constant *SubC = ConstantExpr::getSub(RHS, cast<Constant>(BOp1));
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002630 return new ICmpInst(Pred, BOp0, SubC);
Sanjay Patel00a324e2016-08-03 22:08:44 +00002631 }
Craig Topper8ed1aa92017-10-03 05:31:07 +00002632 } else if (C.isNullValue()) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002633 // Replace ((add A, B) != 0) with (A != -B) if A or B is
2634 // efficiently invertible, or if the add has just this one use.
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002635 if (Value *NegVal = dyn_castNegVal(BOp1))
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002636 return new ICmpInst(Pred, BOp0, NegVal);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002637 if (Value *NegVal = dyn_castNegVal(BOp0))
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002638 return new ICmpInst(Pred, NegVal, BOp1);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002639 if (BO->hasOneUse()) {
Craig Topperbb4069e2017-07-07 23:16:26 +00002640 Value *Neg = Builder.CreateNeg(BOp1);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002641 Neg->takeName(BO);
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002642 return new ICmpInst(Pred, BOp0, Neg);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002643 }
2644 }
2645 break;
Sanjay Patel00a324e2016-08-03 22:08:44 +00002646 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002647 case Instruction::Xor:
2648 if (BO->hasOneUse()) {
Sanjay Patel51a767c2016-08-03 17:23:08 +00002649 if (Constant *BOC = dyn_cast<Constant>(BOp1)) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002650 // For the xor case, we can xor two constants together, eliminating
2651 // the explicit xor.
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002652 return new ICmpInst(Pred, BOp0, ConstantExpr::getXor(RHS, BOC));
Craig Topper8ed1aa92017-10-03 05:31:07 +00002653 } else if (C.isNullValue()) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002654 // Replace ((xor A, B) != 0) with (A != B)
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002655 return new ICmpInst(Pred, BOp0, BOp1);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002656 }
2657 }
2658 break;
2659 case Instruction::Sub:
2660 if (BO->hasOneUse()) {
Sanjay Patel9d591d12016-08-04 15:19:25 +00002661 const APInt *BOC;
2662 if (match(BOp0, m_APInt(BOC))) {
Sanjay Patel362ff5c2016-09-15 17:01:17 +00002663 // Replace ((sub BOC, B) != C) with (B != BOC-C).
Sanjay Patel9d591d12016-08-04 15:19:25 +00002664 Constant *SubC = ConstantExpr::getSub(cast<Constant>(BOp0), RHS);
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002665 return new ICmpInst(Pred, BOp1, SubC);
Craig Topper8ed1aa92017-10-03 05:31:07 +00002666 } else if (C.isNullValue()) {
Sanjay Patel362ff5c2016-09-15 17:01:17 +00002667 // Replace ((sub A, B) != 0) with (A != B).
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002668 return new ICmpInst(Pred, BOp0, BOp1);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002669 }
2670 }
2671 break;
Sanjay Patelb3de75d2016-08-04 19:12:12 +00002672 case Instruction::Or: {
2673 const APInt *BOC;
2674 if (match(BOp1, m_APInt(BOC)) && BO->hasOneUse() && RHS->isAllOnesValue()) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002675 // Comparing if all bits outside of a constant mask are set?
2676 // Replace (X | C) == -1 with (X & ~C) == ~C.
2677 // This removes the -1 constant.
Sanjay Patelb3de75d2016-08-04 19:12:12 +00002678 Constant *NotBOC = ConstantExpr::getNot(cast<Constant>(BOp1));
Craig Topperbb4069e2017-07-07 23:16:26 +00002679 Value *And = Builder.CreateAnd(BOp0, NotBOC);
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002680 return new ICmpInst(Pred, And, NotBOC);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002681 }
2682 break;
Sanjay Patelb3de75d2016-08-04 19:12:12 +00002683 }
Sanjay Pateld938e882016-08-04 20:05:02 +00002684 case Instruction::And: {
2685 const APInt *BOC;
2686 if (match(BOp1, m_APInt(BOC))) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002687 // If we have ((X & C) == C), turn it into ((X & C) != 0).
Craig Topper8ed1aa92017-10-03 05:31:07 +00002688 if (C == *BOC && C.isPowerOf2())
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002689 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE,
Sanjay Patelab50a932016-08-02 22:38:33 +00002690 BO, Constant::getNullValue(RHS->getType()));
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002691
2692 // Don't perform the following transforms if the AND has multiple uses
2693 if (!BO->hasOneUse())
2694 break;
2695
2696 // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
Craig Topperbcfd2d12017-04-20 16:56:25 +00002697 if (BOC->isSignMask()) {
Sanjay Patel51a767c2016-08-03 17:23:08 +00002698 Constant *Zero = Constant::getNullValue(BOp0->getType());
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002699 auto NewPred = isICMP_NE ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
2700 return new ICmpInst(NewPred, BOp0, Zero);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002701 }
2702
2703 // ((X & ~7) == 0) --> X < 8
Craig Topper8ed1aa92017-10-03 05:31:07 +00002704 if (C.isNullValue() && (~(*BOC) + 1).isPowerOf2()) {
Sanjay Pateld938e882016-08-04 20:05:02 +00002705 Constant *NegBOC = ConstantExpr::getNeg(cast<Constant>(BOp1));
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002706 auto NewPred = isICMP_NE ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
2707 return new ICmpInst(NewPred, BOp0, NegBOC);
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002708 }
2709 }
2710 break;
Sanjay Pateld938e882016-08-04 20:05:02 +00002711 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002712 case Instruction::Mul:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002713 if (C.isNullValue() && BO->hasNoSignedWrap()) {
Sanjay Patel3bade132016-08-04 22:19:27 +00002714 const APInt *BOC;
Craig Topper73ba1c82017-06-07 07:40:37 +00002715 if (match(BOp1, m_APInt(BOC)) && !BOC->isNullValue()) {
Sanjay Patel3bade132016-08-04 22:19:27 +00002716 // The trivial case (mul X, 0) is handled by InstSimplify.
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002717 // General case : (mul X, C) != 0 iff X != 0
2718 // (mul X, C) == 0 iff X == 0
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002719 return new ICmpInst(Pred, BOp0, Constant::getNullValue(RHS->getType()));
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002720 }
2721 }
2722 break;
Sanjay Patel6ebd5852016-07-23 00:28:39 +00002723 case Instruction::UDiv:
Craig Topper8ed1aa92017-10-03 05:31:07 +00002724 if (C.isNullValue()) {
Sanjay Patel6ebd5852016-07-23 00:28:39 +00002725 // (icmp eq/ne (udiv A, B), 0) -> (icmp ugt/ule i32 B, A)
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002726 auto NewPred = isICMP_NE ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_UGT;
2727 return new ICmpInst(NewPred, BOp1, BOp0);
Sanjay Patel6ebd5852016-07-23 00:28:39 +00002728 }
2729 break;
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002730 default:
2731 break;
2732 }
2733 return nullptr;
2734}
2735
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002736/// Fold an icmp with LLVM intrinsic and constant operand: icmp Pred II, C.
2737Instruction *InstCombiner::foldICmpIntrinsicWithConstant(ICmpInst &Cmp,
Craig Topper8ed1aa92017-10-03 05:31:07 +00002738 const APInt &C) {
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002739 IntrinsicInst *II = dyn_cast<IntrinsicInst>(Cmp.getOperand(0));
2740 if (!II || !Cmp.isEquality())
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002741 return nullptr;
2742
Sanjay Patelb51e0722017-07-02 16:05:11 +00002743 // Handle icmp {eq|ne} <intrinsic>, Constant.
2744 Type *Ty = II->getType();
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002745 switch (II->getIntrinsicID()) {
2746 case Intrinsic::bswap:
2747 Worklist.Add(II);
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002748 Cmp.setOperand(0, II->getArgOperand(0));
Craig Topper8ed1aa92017-10-03 05:31:07 +00002749 Cmp.setOperand(1, ConstantInt::get(Ty, C.byteSwap()));
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002750 return &Cmp;
Sanjay Patelb51e0722017-07-02 16:05:11 +00002751
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002752 case Intrinsic::ctlz:
2753 case Intrinsic::cttz:
Amaury Sechet6bea6742016-08-04 05:27:20 +00002754 // ctz(A) == bitwidth(A) -> A == 0 and likewise for !=
Craig Topper8ed1aa92017-10-03 05:31:07 +00002755 if (C == C.getBitWidth()) {
Sanjay Patel1710e7c2016-07-21 17:15:49 +00002756 Worklist.Add(II);
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002757 Cmp.setOperand(0, II->getArgOperand(0));
Sanjay Patelb51e0722017-07-02 16:05:11 +00002758 Cmp.setOperand(1, ConstantInt::getNullValue(Ty));
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002759 return &Cmp;
Chris Lattner2188e402010-01-04 07:37:31 +00002760 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002761 break;
Sanjay Patelb51e0722017-07-02 16:05:11 +00002762
Amaury Sechet6bea6742016-08-04 05:27:20 +00002763 case Intrinsic::ctpop: {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002764 // popcount(A) == 0 -> A == 0 and likewise for !=
Amaury Sechet6bea6742016-08-04 05:27:20 +00002765 // popcount(A) == bitwidth(A) -> A == -1 and likewise for !=
Craig Topper8ed1aa92017-10-03 05:31:07 +00002766 bool IsZero = C.isNullValue();
2767 if (IsZero || C == C.getBitWidth()) {
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002768 Worklist.Add(II);
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002769 Cmp.setOperand(0, II->getArgOperand(0));
Sanjay Patelb51e0722017-07-02 16:05:11 +00002770 auto *NewOp =
2771 IsZero ? Constant::getNullValue(Ty) : Constant::getAllOnesValue(Ty);
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002772 Cmp.setOperand(1, NewOp);
2773 return &Cmp;
Amaury Sechet6bea6742016-08-04 05:27:20 +00002774 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002775 break;
Sanjay Patel0a3d72b2016-09-10 15:33:39 +00002776 }
Sanjay Patel18fa9d32016-07-21 23:27:36 +00002777 default:
2778 break;
Chris Lattner2188e402010-01-04 07:37:31 +00002779 }
Sanjay Patelb51e0722017-07-02 16:05:11 +00002780
Craig Topperf40110f2014-04-25 05:29:35 +00002781 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002782}
2783
Sanjay Patel10494b22016-09-16 16:10:22 +00002784/// Handle icmp with constant (but not simple integer constant) RHS.
2785Instruction *InstCombiner::foldICmpInstWithConstantNotInt(ICmpInst &I) {
2786 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
2787 Constant *RHSC = dyn_cast<Constant>(Op1);
2788 Instruction *LHSI = dyn_cast<Instruction>(Op0);
2789 if (!RHSC || !LHSI)
2790 return nullptr;
2791
2792 switch (LHSI->getOpcode()) {
2793 case Instruction::GetElementPtr:
2794 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
2795 if (RHSC->isNullValue() &&
2796 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
2797 return new ICmpInst(
2798 I.getPredicate(), LHSI->getOperand(0),
2799 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2800 break;
2801 case Instruction::PHI:
2802 // Only fold icmp into the PHI if the phi and icmp are in the same
2803 // block. If in the same block, we're encouraging jump threading. If
2804 // not, we are just pessimizing the code by making an i1 phi.
2805 if (LHSI->getParent() == I.getParent())
Craig Topperfb71b7d2017-04-14 19:20:12 +00002806 if (Instruction *NV = foldOpIntoPhi(I, cast<PHINode>(LHSI)))
Sanjay Patel10494b22016-09-16 16:10:22 +00002807 return NV;
2808 break;
2809 case Instruction::Select: {
2810 // If either operand of the select is a constant, we can fold the
2811 // comparison into the select arms, which will cause one to be
2812 // constant folded and the select turned into a bitwise or.
2813 Value *Op1 = nullptr, *Op2 = nullptr;
2814 ConstantInt *CI = nullptr;
2815 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1))) {
2816 Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2817 CI = dyn_cast<ConstantInt>(Op1);
2818 }
2819 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2))) {
2820 Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2821 CI = dyn_cast<ConstantInt>(Op2);
2822 }
2823
2824 // We only want to perform this transformation if it will not lead to
2825 // additional code. This is true if either both sides of the select
2826 // fold to a constant (in which case the icmp is replaced with a select
2827 // which will usually simplify) or this is the only user of the
2828 // select (in which case we are trading a select+icmp for a simpler
2829 // select+icmp) or all uses of the select can be replaced based on
2830 // dominance information ("Global cases").
2831 bool Transform = false;
2832 if (Op1 && Op2)
2833 Transform = true;
2834 else if (Op1 || Op2) {
2835 // Local case
2836 if (LHSI->hasOneUse())
2837 Transform = true;
2838 // Global cases
2839 else if (CI && !CI->isZero())
2840 // When Op1 is constant try replacing select with second operand.
2841 // Otherwise Op2 is constant and try replacing select with first
2842 // operand.
2843 Transform =
2844 replacedSelectWithOperand(cast<SelectInst>(LHSI), &I, Op1 ? 2 : 1);
2845 }
2846 if (Transform) {
2847 if (!Op1)
Craig Topperbb4069e2017-07-07 23:16:26 +00002848 Op1 = Builder.CreateICmp(I.getPredicate(), LHSI->getOperand(1), RHSC,
2849 I.getName());
Sanjay Patel10494b22016-09-16 16:10:22 +00002850 if (!Op2)
Craig Topperbb4069e2017-07-07 23:16:26 +00002851 Op2 = Builder.CreateICmp(I.getPredicate(), LHSI->getOperand(2), RHSC,
2852 I.getName());
Sanjay Patel10494b22016-09-16 16:10:22 +00002853 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
2854 }
2855 break;
2856 }
2857 case Instruction::IntToPtr:
2858 // icmp pred inttoptr(X), null -> icmp pred X, 0
2859 if (RHSC->isNullValue() &&
2860 DL.getIntPtrType(RHSC->getType()) == LHSI->getOperand(0)->getType())
2861 return new ICmpInst(
2862 I.getPredicate(), LHSI->getOperand(0),
2863 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2864 break;
2865
2866 case Instruction::Load:
2867 // Try to optimize things like "A[i] > 4" to index computations.
2868 if (GetElementPtrInst *GEP =
2869 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
2870 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
2871 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
2872 !cast<LoadInst>(LHSI)->isVolatile())
2873 if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, I))
2874 return Res;
2875 }
2876 break;
2877 }
2878
2879 return nullptr;
2880}
2881
Roman Lebedev68d54cf2018-07-11 19:05:04 +00002882/// Some comparisons can be simplified.
2883/// In this case, we are looking for comparisons that look like
2884/// a check for a lossy truncation.
2885/// Folds:
2886/// x & (-1 >> y) SrcPred x to x DstPred (-1 >> y)
2887/// The Mask can be a constant, too.
Roman Lebedevc7bc4c02018-07-14 20:08:52 +00002888/// For some predicates, the operands are commutative.
2889/// For others, x can only be on a specific side.
Roman Lebedev68d54cf2018-07-11 19:05:04 +00002890static Value *foldICmpWithLowBitMaskedVal(ICmpInst &I,
2891 InstCombiner::BuilderTy &Builder) {
2892 ICmpInst::Predicate SrcPred;
2893 Value *X, *M;
2894 auto m_Mask = m_CombineOr(m_LShr(m_AllOnes(), m_Value()), m_LowBitMask());
2895 if (!match(&I, m_c_ICmp(SrcPred,
2896 m_c_And(m_CombineAnd(m_Mask, m_Value(M)), m_Value(X)),
2897 m_Deferred(X))))
2898 return nullptr;
2899
2900 ICmpInst::Predicate DstPred;
2901 switch (SrcPred) {
2902 case ICmpInst::Predicate::ICMP_EQ:
2903 // x & (-1 >> y) == x -> x u<= (-1 >> y)
2904 DstPred = ICmpInst::Predicate::ICMP_ULE;
2905 break;
Roman Lebedev74f899f2018-07-12 14:56:12 +00002906 case ICmpInst::Predicate::ICMP_NE:
2907 // x & (-1 >> y) != x -> x u> (-1 >> y)
2908 DstPred = ICmpInst::Predicate::ICMP_UGT;
2909 break;
Roman Lebedev74f611a2018-07-14 16:44:43 +00002910 case ICmpInst::Predicate::ICMP_UGT:
2911 // x u> x & (-1 >> y) -> x u> (-1 >> y)
2912 assert(X == I.getOperand(0) && "instsimplify took care of commut. variant");
2913 DstPred = ICmpInst::Predicate::ICMP_UGT;
2914 break;
Roman Lebedevfac48472018-07-14 12:20:06 +00002915 case ICmpInst::Predicate::ICMP_UGE:
2916 // x & (-1 >> y) u>= x -> x u<= (-1 >> y)
2917 assert(X == I.getOperand(1) && "instsimplify took care of commut. variant");
2918 DstPred = ICmpInst::Predicate::ICMP_ULE;
2919 break;
Roman Lebedeve3dc5872018-07-14 12:20:16 +00002920 case ICmpInst::Predicate::ICMP_ULT:
2921 // x & (-1 >> y) u< x -> x u> (-1 >> y)
2922 assert(X == I.getOperand(1) && "instsimplify took care of commut. variant");
2923 DstPred = ICmpInst::Predicate::ICMP_UGT;
2924 break;
Roman Lebedev0f5ec892018-07-14 16:44:54 +00002925 case ICmpInst::Predicate::ICMP_ULE:
2926 // x u<= x & (-1 >> y) -> x u<= (-1 >> y)
2927 assert(X == I.getOperand(0) && "instsimplify took care of commut. variant");
2928 DstPred = ICmpInst::Predicate::ICMP_ULE;
2929 break;
Roman Lebedev859e14a2018-07-14 20:08:16 +00002930 case ICmpInst::Predicate::ICMP_SGT:
2931 // x s> x & (-1 >> y) -> x s> (-1 >> y)
2932 if (X != I.getOperand(0)) // X must be on LHS of comparison!
2933 return nullptr; // Ignore the other case.
2934 DstPred = ICmpInst::Predicate::ICMP_SGT;
2935 break;
Roman Lebedevf1442612018-07-14 20:08:37 +00002936 case ICmpInst::Predicate::ICMP_SGE:
2937 // x & (-1 >> y) s>= x -> x s<= (-1 >> y)
2938 if (X != I.getOperand(1)) // X must be on RHS of comparison!
2939 return nullptr; // Ignore the other case.
2940 DstPred = ICmpInst::Predicate::ICMP_SLE;
2941 break;
Roman Lebedevb972fc32018-07-14 20:08:47 +00002942 case ICmpInst::Predicate::ICMP_SLT:
2943 // x & (-1 >> y) s< x -> x s> (-1 >> y)
2944 if (X != I.getOperand(1)) // X must be on RHS of comparison!
2945 return nullptr; // Ignore the other case.
2946 DstPred = ICmpInst::Predicate::ICMP_SGT;
2947 break;
Roman Lebedev1e61e352018-07-14 20:08:26 +00002948 case ICmpInst::Predicate::ICMP_SLE:
2949 // x s<= x & (-1 >> y) -> x s<= (-1 >> y)
2950 if (X != I.getOperand(0)) // X must be on LHS of comparison!
2951 return nullptr; // Ignore the other case.
2952 DstPred = ICmpInst::Predicate::ICMP_SLE;
2953 break;
Roman Lebedev68d54cf2018-07-11 19:05:04 +00002954 default:
Roman Lebedevc7bc4c02018-07-14 20:08:52 +00002955 llvm_unreachable("All possible folds are handled.");
Roman Lebedev68d54cf2018-07-11 19:05:04 +00002956 }
2957
2958 return Builder.CreateICmp(DstPred, X, M);
2959}
2960
Roman Lebedev3cb87e92018-07-18 10:55:17 +00002961/// Some comparisons can be simplified.
2962/// In this case, we are looking for comparisons that look like
2963/// a check for a lossy signed truncation.
2964/// Folds: (MaskedBits is a constant.)
2965/// ((%x << MaskedBits) a>> MaskedBits) SrcPred %x
2966/// Into:
2967/// (add %x, (1 << (KeptBits-1))) DstPred (1 << KeptBits)
2968/// Where KeptBits = bitwidth(%x) - MaskedBits
2969static Value *
2970foldICmpWithTruncSignExtendedVal(ICmpInst &I,
2971 InstCombiner::BuilderTy &Builder) {
2972 ICmpInst::Predicate SrcPred;
2973 Value *X;
2974 const APInt *C0, *C1; // FIXME: non-splats, potentially with undef.
2975 // We are ok with 'shl' having multiple uses, but 'ashr' must be one-use.
2976 if (!match(&I, m_c_ICmp(SrcPred,
2977 m_OneUse(m_AShr(m_Shl(m_Value(X), m_APInt(C0)),
2978 m_APInt(C1))),
2979 m_Deferred(X))))
2980 return nullptr;
2981
2982 // Potential handling of non-splats: for each element:
2983 // * if both are undef, replace with constant 0.
2984 // Because (1<<0) is OK and is 1, and ((1<<0)>>1) is also OK and is 0.
2985 // * if both are not undef, and are different, bailout.
2986 // * else, only one is undef, then pick the non-undef one.
2987
2988 // The shift amount must be equal.
2989 if (*C0 != *C1)
2990 return nullptr;
2991 const APInt &MaskedBits = *C0;
2992 assert(MaskedBits != 0 && "shift by zero should be folded away already.");
2993
2994 ICmpInst::Predicate DstPred;
2995 switch (SrcPred) {
2996 case ICmpInst::Predicate::ICMP_EQ:
2997 // ((%x << MaskedBits) a>> MaskedBits) == %x
2998 // =>
2999 // (add %x, (1 << (KeptBits-1))) u< (1 << KeptBits)
3000 DstPred = ICmpInst::Predicate::ICMP_ULT;
3001 break;
3002 case ICmpInst::Predicate::ICMP_NE:
3003 // ((%x << MaskedBits) a>> MaskedBits) != %x
3004 // =>
3005 // (add %x, (1 << (KeptBits-1))) u>= (1 << KeptBits)
3006 DstPred = ICmpInst::Predicate::ICMP_UGE;
3007 break;
3008 // FIXME: are more folds possible?
3009 default:
3010 return nullptr;
3011 }
3012
3013 auto *XType = X->getType();
3014 const unsigned XBitWidth = XType->getScalarSizeInBits();
3015 const APInt BitWidth = APInt(XBitWidth, XBitWidth);
3016 assert(BitWidth.ugt(MaskedBits) && "shifts should leave some bits untouched");
3017
3018 // KeptBits = bitwidth(%x) - MaskedBits
3019 const APInt KeptBits = BitWidth - MaskedBits;
3020 assert(KeptBits.ugt(0) && KeptBits.ult(BitWidth) && "unreachable");
3021 // ICmpCst = (1 << KeptBits)
3022 const APInt ICmpCst = APInt(XBitWidth, 1).shl(KeptBits);
3023 assert(ICmpCst.isPowerOf2());
3024 // AddCst = (1 << (KeptBits-1))
3025 const APInt AddCst = ICmpCst.lshr(1);
3026 assert(AddCst.ult(ICmpCst) && AddCst.isPowerOf2());
3027
3028 // T0 = add %x, AddCst
3029 Value *T0 = Builder.CreateAdd(X, ConstantInt::get(XType, AddCst));
3030 // T1 = T0 DstPred ICmpCst
3031 Value *T1 = Builder.CreateICmp(DstPred, T0, ConstantInt::get(XType, ICmpCst));
3032
3033 return T1;
3034}
3035
Sanjay Patel10494b22016-09-16 16:10:22 +00003036/// Try to fold icmp (binop), X or icmp X, (binop).
Sanjay Patel2df38a82017-05-08 16:21:55 +00003037/// TODO: A large part of this logic is duplicated in InstSimplify's
3038/// simplifyICmpWithBinOp(). We should be able to share that and avoid the code
3039/// duplication.
Sanjay Patel10494b22016-09-16 16:10:22 +00003040Instruction *InstCombiner::foldICmpBinOp(ICmpInst &I) {
3041 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
3042
3043 // Special logic for binary operators.
3044 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
3045 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
3046 if (!BO0 && !BO1)
3047 return nullptr;
3048
Sanjay Patel2a062632017-05-08 16:33:42 +00003049 const CmpInst::Predicate Pred = I.getPredicate();
Sanjay Patel1cf07342018-09-11 22:40:20 +00003050 Value *X;
3051
3052 // Convert add-with-unsigned-overflow comparisons into a 'not' with compare.
3053 // (Op1 + X) <u Op1 --> ~Op1 <u X
3054 // Op0 >u (Op0 + X) --> X >u ~Op0
3055 if (match(Op0, m_OneUse(m_c_Add(m_Specific(Op1), m_Value(X)))) &&
3056 Pred == ICmpInst::ICMP_ULT)
3057 return new ICmpInst(Pred, Builder.CreateNot(Op1), X);
3058 if (match(Op1, m_OneUse(m_c_Add(m_Specific(Op0), m_Value(X)))) &&
3059 Pred == ICmpInst::ICMP_UGT)
3060 return new ICmpInst(Pred, X, Builder.CreateNot(Op0));
3061
Sanjay Patel10494b22016-09-16 16:10:22 +00003062 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
3063 if (BO0 && isa<OverflowingBinaryOperator>(BO0))
3064 NoOp0WrapProblem =
3065 ICmpInst::isEquality(Pred) ||
3066 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
3067 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
3068 if (BO1 && isa<OverflowingBinaryOperator>(BO1))
3069 NoOp1WrapProblem =
3070 ICmpInst::isEquality(Pred) ||
3071 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
3072 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
3073
3074 // Analyze the case when either Op0 or Op1 is an add instruction.
3075 // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null).
3076 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
3077 if (BO0 && BO0->getOpcode() == Instruction::Add) {
3078 A = BO0->getOperand(0);
3079 B = BO0->getOperand(1);
3080 }
3081 if (BO1 && BO1->getOpcode() == Instruction::Add) {
3082 C = BO1->getOperand(0);
3083 D = BO1->getOperand(1);
3084 }
3085
Sanjay Patel10494b22016-09-16 16:10:22 +00003086 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
3087 if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
3088 return new ICmpInst(Pred, A == Op1 ? B : A,
3089 Constant::getNullValue(Op1->getType()));
3090
3091 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
3092 if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
3093 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
3094 C == Op0 ? D : C);
3095
3096 // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
3097 if (A && C && (A == C || A == D || B == C || B == D) && NoOp0WrapProblem &&
3098 NoOp1WrapProblem &&
3099 // Try not to increase register pressure.
3100 BO0->hasOneUse() && BO1->hasOneUse()) {
3101 // Determine Y and Z in the form icmp (X+Y), (X+Z).
3102 Value *Y, *Z;
3103 if (A == C) {
3104 // C + B == C + D -> B == D
3105 Y = B;
3106 Z = D;
3107 } else if (A == D) {
3108 // D + B == C + D -> B == C
3109 Y = B;
3110 Z = C;
3111 } else if (B == C) {
3112 // A + C == C + D -> A == D
3113 Y = A;
3114 Z = D;
3115 } else {
3116 assert(B == D);
3117 // A + D == C + D -> A == C
3118 Y = A;
3119 Z = C;
3120 }
3121 return new ICmpInst(Pred, Y, Z);
3122 }
3123
3124 // icmp slt (X + -1), Y -> icmp sle X, Y
3125 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
3126 match(B, m_AllOnes()))
3127 return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
3128
3129 // icmp sge (X + -1), Y -> icmp sgt X, Y
3130 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
3131 match(B, m_AllOnes()))
3132 return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
3133
3134 // icmp sle (X + 1), Y -> icmp slt X, Y
3135 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE && match(B, m_One()))
3136 return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
3137
3138 // icmp sgt (X + 1), Y -> icmp sge X, Y
3139 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT && match(B, m_One()))
3140 return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
3141
3142 // icmp sgt X, (Y + -1) -> icmp sge X, Y
3143 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGT &&
3144 match(D, m_AllOnes()))
3145 return new ICmpInst(CmpInst::ICMP_SGE, Op0, C);
3146
3147 // icmp sle X, (Y + -1) -> icmp slt X, Y
3148 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLE &&
3149 match(D, m_AllOnes()))
3150 return new ICmpInst(CmpInst::ICMP_SLT, Op0, C);
3151
3152 // icmp sge X, (Y + 1) -> icmp sgt X, Y
3153 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SGE && match(D, m_One()))
3154 return new ICmpInst(CmpInst::ICMP_SGT, Op0, C);
3155
3156 // icmp slt X, (Y + 1) -> icmp sle X, Y
3157 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_SLT && match(D, m_One()))
3158 return new ICmpInst(CmpInst::ICMP_SLE, Op0, C);
3159
Sanjay Patel40f40172017-01-13 23:25:46 +00003160 // TODO: The subtraction-related identities shown below also hold, but
3161 // canonicalization from (X -nuw 1) to (X + -1) means that the combinations
3162 // wouldn't happen even if they were implemented.
3163 //
3164 // icmp ult (X - 1), Y -> icmp ule X, Y
3165 // icmp uge (X - 1), Y -> icmp ugt X, Y
3166 // icmp ugt X, (Y - 1) -> icmp uge X, Y
3167 // icmp ule X, (Y - 1) -> icmp ult X, Y
3168
3169 // icmp ule (X + 1), Y -> icmp ult X, Y
3170 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_ULE && match(B, m_One()))
3171 return new ICmpInst(CmpInst::ICMP_ULT, A, Op1);
3172
3173 // icmp ugt (X + 1), Y -> icmp uge X, Y
3174 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_UGT && match(B, m_One()))
3175 return new ICmpInst(CmpInst::ICMP_UGE, A, Op1);
3176
3177 // icmp uge X, (Y + 1) -> icmp ugt X, Y
3178 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_UGE && match(D, m_One()))
3179 return new ICmpInst(CmpInst::ICMP_UGT, Op0, C);
3180
3181 // icmp ult X, (Y + 1) -> icmp ule X, Y
3182 if (C && NoOp1WrapProblem && Pred == CmpInst::ICMP_ULT && match(D, m_One()))
3183 return new ICmpInst(CmpInst::ICMP_ULE, Op0, C);
3184
Sanjay Patel10494b22016-09-16 16:10:22 +00003185 // if C1 has greater magnitude than C2:
3186 // icmp (X + C1), (Y + C2) -> icmp (X + C3), Y
3187 // s.t. C3 = C1 - C2
3188 //
3189 // if C2 has greater magnitude than C1:
3190 // icmp (X + C1), (Y + C2) -> icmp X, (Y + C3)
3191 // s.t. C3 = C2 - C1
3192 if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
3193 (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
3194 if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
3195 if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
3196 const APInt &AP1 = C1->getValue();
3197 const APInt &AP2 = C2->getValue();
3198 if (AP1.isNegative() == AP2.isNegative()) {
3199 APInt AP1Abs = C1->getValue().abs();
3200 APInt AP2Abs = C2->getValue().abs();
3201 if (AP1Abs.uge(AP2Abs)) {
Craig Topperbb4069e2017-07-07 23:16:26 +00003202 ConstantInt *C3 = Builder.getInt(AP1 - AP2);
3203 Value *NewAdd = Builder.CreateNSWAdd(A, C3);
Sanjay Patel10494b22016-09-16 16:10:22 +00003204 return new ICmpInst(Pred, NewAdd, C);
3205 } else {
Craig Topperbb4069e2017-07-07 23:16:26 +00003206 ConstantInt *C3 = Builder.getInt(AP2 - AP1);
3207 Value *NewAdd = Builder.CreateNSWAdd(C, C3);
Sanjay Patel10494b22016-09-16 16:10:22 +00003208 return new ICmpInst(Pred, A, NewAdd);
3209 }
3210 }
3211 }
3212
3213 // Analyze the case when either Op0 or Op1 is a sub instruction.
3214 // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null).
3215 A = nullptr;
3216 B = nullptr;
3217 C = nullptr;
3218 D = nullptr;
3219 if (BO0 && BO0->getOpcode() == Instruction::Sub) {
3220 A = BO0->getOperand(0);
3221 B = BO0->getOperand(1);
3222 }
3223 if (BO1 && BO1->getOpcode() == Instruction::Sub) {
3224 C = BO1->getOperand(0);
3225 D = BO1->getOperand(1);
3226 }
3227
3228 // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
3229 if (A == Op1 && NoOp0WrapProblem)
3230 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
Sanjay Patel10494b22016-09-16 16:10:22 +00003231 // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
3232 if (C == Op0 && NoOp1WrapProblem)
3233 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
3234
Sanjay Patelcbb04502018-04-02 20:37:40 +00003235 // (A - B) >u A --> A <u B
3236 if (A == Op1 && Pred == ICmpInst::ICMP_UGT)
3237 return new ICmpInst(ICmpInst::ICMP_ULT, A, B);
3238 // C <u (C - D) --> C <u D
3239 if (C == Op0 && Pred == ICmpInst::ICMP_ULT)
3240 return new ICmpInst(ICmpInst::ICMP_ULT, C, D);
3241
Sanjay Patel10494b22016-09-16 16:10:22 +00003242 // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
3243 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
3244 // Try not to increase register pressure.
3245 BO0->hasOneUse() && BO1->hasOneUse())
3246 return new ICmpInst(Pred, A, C);
Sanjay Patel10494b22016-09-16 16:10:22 +00003247 // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
3248 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
3249 // Try not to increase register pressure.
3250 BO0->hasOneUse() && BO1->hasOneUse())
3251 return new ICmpInst(Pred, D, B);
3252
3253 // icmp (0-X) < cst --> x > -cst
3254 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) {
3255 Value *X;
3256 if (match(BO0, m_Neg(m_Value(X))))
Chen Zhengb9722732018-07-16 00:51:40 +00003257 if (Constant *RHSC = dyn_cast<Constant>(Op1))
3258 if (RHSC->isNotMinSignedValue())
Sanjay Patel10494b22016-09-16 16:10:22 +00003259 return new ICmpInst(I.getSwappedPredicate(), X,
3260 ConstantExpr::getNeg(RHSC));
3261 }
3262
3263 BinaryOperator *SRem = nullptr;
3264 // icmp (srem X, Y), Y
3265 if (BO0 && BO0->getOpcode() == Instruction::SRem && Op1 == BO0->getOperand(1))
3266 SRem = BO0;
3267 // icmp Y, (srem X, Y)
3268 else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
3269 Op0 == BO1->getOperand(1))
3270 SRem = BO1;
3271 if (SRem) {
3272 // We don't check hasOneUse to avoid increasing register pressure because
3273 // the value we use is the same value this instruction was already using.
3274 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
3275 default:
3276 break;
3277 case ICmpInst::ICMP_EQ:
3278 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
3279 case ICmpInst::ICMP_NE:
3280 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
3281 case ICmpInst::ICMP_SGT:
3282 case ICmpInst::ICMP_SGE:
3283 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
3284 Constant::getAllOnesValue(SRem->getType()));
3285 case ICmpInst::ICMP_SLT:
3286 case ICmpInst::ICMP_SLE:
3287 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
3288 Constant::getNullValue(SRem->getType()));
3289 }
3290 }
3291
3292 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() && BO0->hasOneUse() &&
3293 BO1->hasOneUse() && BO0->getOperand(1) == BO1->getOperand(1)) {
3294 switch (BO0->getOpcode()) {
3295 default:
3296 break;
3297 case Instruction::Add:
3298 case Instruction::Sub:
Sanjay Pateld3106ad2017-05-23 17:29:58 +00003299 case Instruction::Xor: {
Sanjay Patel10494b22016-09-16 16:10:22 +00003300 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
Sanjay Patel2a062632017-05-08 16:33:42 +00003301 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
Sanjay Pateld3106ad2017-05-23 17:29:58 +00003302
3303 const APInt *C;
3304 if (match(BO0->getOperand(1), m_APInt(C))) {
3305 // icmp u/s (a ^ signmask), (b ^ signmask) --> icmp s/u a, b
3306 if (C->isSignMask()) {
Sanjay Patel2a062632017-05-08 16:33:42 +00003307 ICmpInst::Predicate NewPred =
Sanjay Patel10494b22016-09-16 16:10:22 +00003308 I.isSigned() ? I.getUnsignedPredicate() : I.getSignedPredicate();
Sanjay Patel2a062632017-05-08 16:33:42 +00003309 return new ICmpInst(NewPred, BO0->getOperand(0), BO1->getOperand(0));
Sanjay Patel10494b22016-09-16 16:10:22 +00003310 }
3311
Sanjay Pateld3106ad2017-05-23 17:29:58 +00003312 // icmp u/s (a ^ maxsignval), (b ^ maxsignval) --> icmp s/u' a, b
3313 if (BO0->getOpcode() == Instruction::Xor && C->isMaxSignedValue()) {
Sanjay Patel2a062632017-05-08 16:33:42 +00003314 ICmpInst::Predicate NewPred =
Sanjay Patel10494b22016-09-16 16:10:22 +00003315 I.isSigned() ? I.getUnsignedPredicate() : I.getSignedPredicate();
Sanjay Patel2a062632017-05-08 16:33:42 +00003316 NewPred = I.getSwappedPredicate(NewPred);
3317 return new ICmpInst(NewPred, BO0->getOperand(0), BO1->getOperand(0));
Sanjay Patel10494b22016-09-16 16:10:22 +00003318 }
3319 }
3320 break;
Sanjay Pateld3106ad2017-05-23 17:29:58 +00003321 }
Sanjay Patel07b1ba52017-05-24 22:58:17 +00003322 case Instruction::Mul: {
Sanjay Patel10494b22016-09-16 16:10:22 +00003323 if (!I.isEquality())
3324 break;
3325
Sanjay Patel07b1ba52017-05-24 22:58:17 +00003326 const APInt *C;
Craig Topper73ba1c82017-06-07 07:40:37 +00003327 if (match(BO0->getOperand(1), m_APInt(C)) && !C->isNullValue() &&
3328 !C->isOneValue()) {
Sanjay Patel07b1ba52017-05-24 22:58:17 +00003329 // icmp eq/ne (X * C), (Y * C) --> icmp (X & Mask), (Y & Mask)
3330 // Mask = -1 >> count-trailing-zeros(C).
Sanjay Patel51506122017-05-25 14:13:57 +00003331 if (unsigned TZs = C->countTrailingZeros()) {
Sanjay Patel07b1ba52017-05-24 22:58:17 +00003332 Constant *Mask = ConstantInt::get(
3333 BO0->getType(),
Sanjay Patel51506122017-05-25 14:13:57 +00003334 APInt::getLowBitsSet(C->getBitWidth(), C->getBitWidth() - TZs));
Craig Topperbb4069e2017-07-07 23:16:26 +00003335 Value *And1 = Builder.CreateAnd(BO0->getOperand(0), Mask);
3336 Value *And2 = Builder.CreateAnd(BO1->getOperand(0), Mask);
Sanjay Patel2a062632017-05-08 16:33:42 +00003337 return new ICmpInst(Pred, And1, And2);
Sanjay Patel10494b22016-09-16 16:10:22 +00003338 }
Sanjay Patel51506122017-05-25 14:13:57 +00003339 // If there are no trailing zeros in the multiplier, just eliminate
3340 // the multiplies (no masking is needed):
3341 // icmp eq/ne (X * C), (Y * C) --> icmp eq/ne X, Y
3342 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
Sanjay Patel10494b22016-09-16 16:10:22 +00003343 }
3344 break;
Sanjay Patel07b1ba52017-05-24 22:58:17 +00003345 }
Sanjay Patel10494b22016-09-16 16:10:22 +00003346 case Instruction::UDiv:
3347 case Instruction::LShr:
Sanjay Patel878715f2017-05-15 19:27:53 +00003348 if (I.isSigned() || !BO0->isExact() || !BO1->isExact())
Sanjay Patel10494b22016-09-16 16:10:22 +00003349 break;
Sanjay Patel878715f2017-05-15 19:27:53 +00003350 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
3351
Sanjay Patel10494b22016-09-16 16:10:22 +00003352 case Instruction::SDiv:
Sanjay Patel878715f2017-05-15 19:27:53 +00003353 if (!I.isEquality() || !BO0->isExact() || !BO1->isExact())
3354 break;
3355 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
3356
Sanjay Patel10494b22016-09-16 16:10:22 +00003357 case Instruction::AShr:
3358 if (!BO0->isExact() || !BO1->isExact())
3359 break;
Sanjay Patel2a062632017-05-08 16:33:42 +00003360 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
Sanjay Patel878715f2017-05-15 19:27:53 +00003361
Sanjay Patel10494b22016-09-16 16:10:22 +00003362 case Instruction::Shl: {
3363 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
3364 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
3365 if (!NUW && !NSW)
3366 break;
3367 if (!NSW && I.isSigned())
3368 break;
Sanjay Patel2a062632017-05-08 16:33:42 +00003369 return new ICmpInst(Pred, BO0->getOperand(0), BO1->getOperand(0));
Sanjay Patel10494b22016-09-16 16:10:22 +00003370 }
3371 }
3372 }
3373
3374 if (BO0) {
3375 // Transform A & (L - 1) `ult` L --> L != 0
3376 auto LSubOne = m_Add(m_Specific(Op1), m_AllOnes());
Craig Topper72ee6942017-06-24 06:24:01 +00003377 auto BitwiseAnd = m_c_And(m_Value(), LSubOne);
Sanjay Patel10494b22016-09-16 16:10:22 +00003378
Sanjay Patel2a062632017-05-08 16:33:42 +00003379 if (match(BO0, BitwiseAnd) && Pred == ICmpInst::ICMP_ULT) {
Sanjay Patel10494b22016-09-16 16:10:22 +00003380 auto *Zero = Constant::getNullValue(BO0->getType());
3381 return new ICmpInst(ICmpInst::ICMP_NE, Op1, Zero);
3382 }
3383 }
3384
Roman Lebedev68d54cf2018-07-11 19:05:04 +00003385 if (Value *V = foldICmpWithLowBitMaskedVal(I, Builder))
3386 return replaceInstUsesWith(I, V);
3387
Roman Lebedev3cb87e92018-07-18 10:55:17 +00003388 if (Value *V = foldICmpWithTruncSignExtendedVal(I, Builder))
3389 return replaceInstUsesWith(I, V);
3390
Sanjay Patel10494b22016-09-16 16:10:22 +00003391 return nullptr;
3392}
3393
Sanjay Pateldd46b522016-12-19 17:32:37 +00003394/// Fold icmp Pred min|max(X, Y), X.
3395static Instruction *foldICmpWithMinMax(ICmpInst &Cmp) {
Sanjay Pateld6406412016-12-15 19:13:37 +00003396 ICmpInst::Predicate Pred = Cmp.getPredicate();
3397 Value *Op0 = Cmp.getOperand(0);
3398 Value *X = Cmp.getOperand(1);
3399
Sanjay Pateldd46b522016-12-19 17:32:37 +00003400 // Canonicalize minimum or maximum operand to LHS of the icmp.
Sanjay Patel8296c6c2016-12-19 16:28:53 +00003401 if (match(X, m_c_SMin(m_Specific(Op0), m_Value())) ||
Sanjay Pateldd46b522016-12-19 17:32:37 +00003402 match(X, m_c_SMax(m_Specific(Op0), m_Value())) ||
3403 match(X, m_c_UMin(m_Specific(Op0), m_Value())) ||
3404 match(X, m_c_UMax(m_Specific(Op0), m_Value()))) {
Sanjay Pateld6406412016-12-15 19:13:37 +00003405 std::swap(Op0, X);
3406 Pred = Cmp.getSwappedPredicate();
3407 }
3408
3409 Value *Y;
Sanjay Patel8296c6c2016-12-19 16:28:53 +00003410 if (match(Op0, m_c_SMin(m_Specific(X), m_Value(Y)))) {
Sanjay Pateldd46b522016-12-19 17:32:37 +00003411 // smin(X, Y) == X --> X s<= Y
3412 // smin(X, Y) s>= X --> X s<= Y
Sanjay Patel8296c6c2016-12-19 16:28:53 +00003413 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_SGE)
3414 return new ICmpInst(ICmpInst::ICMP_SLE, X, Y);
3415
Sanjay Pateldd46b522016-12-19 17:32:37 +00003416 // smin(X, Y) != X --> X s> Y
3417 // smin(X, Y) s< X --> X s> Y
Sanjay Patel8296c6c2016-12-19 16:28:53 +00003418 if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_SLT)
3419 return new ICmpInst(ICmpInst::ICMP_SGT, X, Y);
3420
3421 // These cases should be handled in InstSimplify:
Sanjay Pateldd46b522016-12-19 17:32:37 +00003422 // smin(X, Y) s<= X --> true
3423 // smin(X, Y) s> X --> false
Sanjay Pateld6406412016-12-15 19:13:37 +00003424 return nullptr;
Sanjay Patel8296c6c2016-12-19 16:28:53 +00003425 }
Sanjay Pateldd46b522016-12-19 17:32:37 +00003426
Sanjay Patel8296c6c2016-12-19 16:28:53 +00003427 if (match(Op0, m_c_SMax(m_Specific(X), m_Value(Y)))) {
Sanjay Pateldd46b522016-12-19 17:32:37 +00003428 // smax(X, Y) == X --> X s>= Y
3429 // smax(X, Y) s<= X --> X s>= Y
Sanjay Patel8296c6c2016-12-19 16:28:53 +00003430 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_SLE)
3431 return new ICmpInst(ICmpInst::ICMP_SGE, X, Y);
Sanjay Pateld6406412016-12-15 19:13:37 +00003432
Sanjay Pateldd46b522016-12-19 17:32:37 +00003433 // smax(X, Y) != X --> X s< Y
3434 // smax(X, Y) s> X --> X s< Y
Sanjay Patel8296c6c2016-12-19 16:28:53 +00003435 if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_SGT)
3436 return new ICmpInst(ICmpInst::ICMP_SLT, X, Y);
Sanjay Pateld6406412016-12-15 19:13:37 +00003437
Sanjay Patel8296c6c2016-12-19 16:28:53 +00003438 // These cases should be handled in InstSimplify:
Sanjay Pateldd46b522016-12-19 17:32:37 +00003439 // smax(X, Y) s>= X --> true
3440 // smax(X, Y) s< X --> false
3441 return nullptr;
3442 }
3443
3444 if (match(Op0, m_c_UMin(m_Specific(X), m_Value(Y)))) {
3445 // umin(X, Y) == X --> X u<= Y
3446 // umin(X, Y) u>= X --> X u<= Y
3447 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_UGE)
3448 return new ICmpInst(ICmpInst::ICMP_ULE, X, Y);
3449
3450 // umin(X, Y) != X --> X u> Y
3451 // umin(X, Y) u< X --> X u> Y
3452 if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_ULT)
3453 return new ICmpInst(ICmpInst::ICMP_UGT, X, Y);
3454
3455 // These cases should be handled in InstSimplify:
3456 // umin(X, Y) u<= X --> true
3457 // umin(X, Y) u> X --> false
3458 return nullptr;
3459 }
3460
3461 if (match(Op0, m_c_UMax(m_Specific(X), m_Value(Y)))) {
3462 // umax(X, Y) == X --> X u>= Y
3463 // umax(X, Y) u<= X --> X u>= Y
3464 if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_ULE)
3465 return new ICmpInst(ICmpInst::ICMP_UGE, X, Y);
3466
3467 // umax(X, Y) != X --> X u< Y
3468 // umax(X, Y) u> X --> X u< Y
3469 if (Pred == CmpInst::ICMP_NE || Pred == CmpInst::ICMP_UGT)
3470 return new ICmpInst(ICmpInst::ICMP_ULT, X, Y);
3471
3472 // These cases should be handled in InstSimplify:
3473 // umax(X, Y) u>= X --> true
3474 // umax(X, Y) u< X --> false
Sanjay Patel8296c6c2016-12-19 16:28:53 +00003475 return nullptr;
3476 }
Sanjay Pateld6406412016-12-15 19:13:37 +00003477
Sanjay Pateld6406412016-12-15 19:13:37 +00003478 return nullptr;
3479}
3480
Sanjay Patel10494b22016-09-16 16:10:22 +00003481Instruction *InstCombiner::foldICmpEquality(ICmpInst &I) {
3482 if (!I.isEquality())
3483 return nullptr;
3484
3485 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Sanjay Patel4e96f192017-06-28 16:39:06 +00003486 const CmpInst::Predicate Pred = I.getPredicate();
Sanjay Patel10494b22016-09-16 16:10:22 +00003487 Value *A, *B, *C, *D;
3488 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
3489 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0
3490 Value *OtherVal = A == Op1 ? B : A;
Sanjay Patel4e96f192017-06-28 16:39:06 +00003491 return new ICmpInst(Pred, OtherVal, Constant::getNullValue(A->getType()));
Sanjay Patel10494b22016-09-16 16:10:22 +00003492 }
3493
3494 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
3495 // A^c1 == C^c2 --> A == C^(c1^c2)
3496 ConstantInt *C1, *C2;
3497 if (match(B, m_ConstantInt(C1)) && match(D, m_ConstantInt(C2)) &&
3498 Op1->hasOneUse()) {
Craig Topperbb4069e2017-07-07 23:16:26 +00003499 Constant *NC = Builder.getInt(C1->getValue() ^ C2->getValue());
3500 Value *Xor = Builder.CreateXor(C, NC);
Sanjay Patel4e96f192017-06-28 16:39:06 +00003501 return new ICmpInst(Pred, A, Xor);
Sanjay Patel10494b22016-09-16 16:10:22 +00003502 }
3503
3504 // A^B == A^D -> B == D
3505 if (A == C)
Sanjay Patel4e96f192017-06-28 16:39:06 +00003506 return new ICmpInst(Pred, B, D);
Sanjay Patel10494b22016-09-16 16:10:22 +00003507 if (A == D)
Sanjay Patel4e96f192017-06-28 16:39:06 +00003508 return new ICmpInst(Pred, B, C);
Sanjay Patel10494b22016-09-16 16:10:22 +00003509 if (B == C)
Sanjay Patel4e96f192017-06-28 16:39:06 +00003510 return new ICmpInst(Pred, A, D);
Sanjay Patel10494b22016-09-16 16:10:22 +00003511 if (B == D)
Sanjay Patel4e96f192017-06-28 16:39:06 +00003512 return new ICmpInst(Pred, A, C);
Sanjay Patel10494b22016-09-16 16:10:22 +00003513 }
3514 }
3515
3516 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) && (A == Op0 || B == Op0)) {
3517 // A == (A^B) -> B == 0
3518 Value *OtherVal = A == Op0 ? B : A;
Sanjay Patel4e96f192017-06-28 16:39:06 +00003519 return new ICmpInst(Pred, OtherVal, Constant::getNullValue(A->getType()));
Sanjay Patel10494b22016-09-16 16:10:22 +00003520 }
3521
3522 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
3523 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
3524 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
3525 Value *X = nullptr, *Y = nullptr, *Z = nullptr;
3526
3527 if (A == C) {
3528 X = B;
3529 Y = D;
3530 Z = A;
3531 } else if (A == D) {
3532 X = B;
3533 Y = C;
3534 Z = A;
3535 } else if (B == C) {
3536 X = A;
3537 Y = D;
3538 Z = B;
3539 } else if (B == D) {
3540 X = A;
3541 Y = C;
3542 Z = B;
3543 }
3544
3545 if (X) { // Build (X^Y) & Z
Craig Topperbb4069e2017-07-07 23:16:26 +00003546 Op1 = Builder.CreateXor(X, Y);
3547 Op1 = Builder.CreateAnd(Op1, Z);
Sanjay Patel10494b22016-09-16 16:10:22 +00003548 I.setOperand(0, Op1);
3549 I.setOperand(1, Constant::getNullValue(Op1->getType()));
3550 return &I;
3551 }
3552 }
3553
3554 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
3555 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B)
3556 ConstantInt *Cst1;
3557 if ((Op0->hasOneUse() && match(Op0, m_ZExt(m_Value(A))) &&
3558 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
3559 (Op1->hasOneUse() && match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
3560 match(Op1, m_ZExt(m_Value(A))))) {
3561 APInt Pow2 = Cst1->getValue() + 1;
3562 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
3563 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
Craig Topperbb4069e2017-07-07 23:16:26 +00003564 return new ICmpInst(Pred, A, Builder.CreateTrunc(B, A->getType()));
Sanjay Patel10494b22016-09-16 16:10:22 +00003565 }
3566
3567 // (A >> C) == (B >> C) --> (A^B) u< (1 << C)
3568 // For lshr and ashr pairs.
3569 if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) &&
3570 match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) ||
3571 (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) &&
3572 match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) {
3573 unsigned TypeBits = Cst1->getBitWidth();
3574 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
3575 if (ShAmt < TypeBits && ShAmt != 0) {
Sanjay Patel4e96f192017-06-28 16:39:06 +00003576 ICmpInst::Predicate NewPred =
3577 Pred == ICmpInst::ICMP_NE ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
Craig Topperbb4069e2017-07-07 23:16:26 +00003578 Value *Xor = Builder.CreateXor(A, B, I.getName() + ".unshifted");
Sanjay Patel10494b22016-09-16 16:10:22 +00003579 APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt);
Craig Topperbb4069e2017-07-07 23:16:26 +00003580 return new ICmpInst(NewPred, Xor, Builder.getInt(CmpVal));
Sanjay Patel10494b22016-09-16 16:10:22 +00003581 }
3582 }
3583
3584 // (A << C) == (B << C) --> ((A^B) & (~0U >> C)) == 0
3585 if (match(Op0, m_OneUse(m_Shl(m_Value(A), m_ConstantInt(Cst1)))) &&
3586 match(Op1, m_OneUse(m_Shl(m_Value(B), m_Specific(Cst1))))) {
3587 unsigned TypeBits = Cst1->getBitWidth();
3588 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
3589 if (ShAmt < TypeBits && ShAmt != 0) {
Craig Topperbb4069e2017-07-07 23:16:26 +00003590 Value *Xor = Builder.CreateXor(A, B, I.getName() + ".unshifted");
Sanjay Patel10494b22016-09-16 16:10:22 +00003591 APInt AndVal = APInt::getLowBitsSet(TypeBits, TypeBits - ShAmt);
Craig Topperbb4069e2017-07-07 23:16:26 +00003592 Value *And = Builder.CreateAnd(Xor, Builder.getInt(AndVal),
Sanjay Patel10494b22016-09-16 16:10:22 +00003593 I.getName() + ".mask");
Sanjay Patel4e96f192017-06-28 16:39:06 +00003594 return new ICmpInst(Pred, And, Constant::getNullValue(Cst1->getType()));
Sanjay Patel10494b22016-09-16 16:10:22 +00003595 }
3596 }
3597
3598 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
3599 // "icmp (and X, mask), cst"
3600 uint64_t ShAmt = 0;
3601 if (Op0->hasOneUse() &&
3602 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A), m_ConstantInt(ShAmt))))) &&
3603 match(Op1, m_ConstantInt(Cst1)) &&
3604 // Only do this when A has multiple uses. This is most important to do
3605 // when it exposes other optimizations.
3606 !A->hasOneUse()) {
3607 unsigned ASize = cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
3608
3609 if (ShAmt < ASize) {
3610 APInt MaskV =
3611 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
3612 MaskV <<= ShAmt;
3613
3614 APInt CmpV = Cst1->getValue().zext(ASize);
3615 CmpV <<= ShAmt;
3616
Craig Topperbb4069e2017-07-07 23:16:26 +00003617 Value *Mask = Builder.CreateAnd(A, Builder.getInt(MaskV));
3618 return new ICmpInst(Pred, Mask, Builder.getInt(CmpV));
Sanjay Patel10494b22016-09-16 16:10:22 +00003619 }
3620 }
3621
Sanjay Patelc3d5cf02017-07-02 14:34:50 +00003622 // If both operands are byte-swapped or bit-reversed, just compare the
3623 // original values.
3624 // TODO: Move this to a function similar to foldICmpIntrinsicWithConstant()
3625 // and handle more intrinsics.
3626 if ((match(Op0, m_BSwap(m_Value(A))) && match(Op1, m_BSwap(m_Value(B)))) ||
Simon Pilgrimdf2657a2017-07-02 16:31:16 +00003627 (match(Op0, m_BitReverse(m_Value(A))) &&
3628 match(Op1, m_BitReverse(m_Value(B)))))
Sanjay Patelc3d5cf02017-07-02 14:34:50 +00003629 return new ICmpInst(Pred, A, B);
3630
Sanjay Patel10494b22016-09-16 16:10:22 +00003631 return nullptr;
3632}
3633
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003634/// Handle icmp (cast x to y), (cast/cst). We only handle extending casts so
3635/// far.
Sanjay Patel43395062016-07-21 18:07:40 +00003636Instruction *InstCombiner::foldICmpWithCastAndCast(ICmpInst &ICmp) {
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003637 const CastInst *LHSCI = cast<CastInst>(ICmp.getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +00003638 Value *LHSCIOp = LHSCI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00003639 Type *SrcTy = LHSCIOp->getType();
3640 Type *DestTy = LHSCI->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00003641 Value *RHSCIOp;
3642
Jim Grosbach129c52a2011-09-30 18:09:53 +00003643 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
Chris Lattner2188e402010-01-04 07:37:31 +00003644 // integer type is the same size as the pointer type.
Daniel Neilsonbdda1152018-03-05 18:05:51 +00003645 const auto& CompatibleSizes = [&](Type* SrcTy, Type* DestTy) -> bool {
3646 if (isa<VectorType>(SrcTy)) {
3647 SrcTy = cast<VectorType>(SrcTy)->getElementType();
3648 DestTy = cast<VectorType>(DestTy)->getElementType();
3649 }
3650 return DL.getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth();
3651 };
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003652 if (LHSCI->getOpcode() == Instruction::PtrToInt &&
Daniel Neilsonbdda1152018-03-05 18:05:51 +00003653 CompatibleSizes(SrcTy, DestTy)) {
Craig Topperf40110f2014-04-25 05:29:35 +00003654 Value *RHSOp = nullptr;
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003655 if (auto *RHSC = dyn_cast<PtrToIntOperator>(ICmp.getOperand(1))) {
Michael Liaod266b922015-02-13 04:51:26 +00003656 Value *RHSCIOp = RHSC->getOperand(0);
3657 if (RHSCIOp->getType()->getPointerAddressSpace() ==
3658 LHSCIOp->getType()->getPointerAddressSpace()) {
3659 RHSOp = RHSC->getOperand(0);
3660 // If the pointer types don't match, insert a bitcast.
3661 if (LHSCIOp->getType() != RHSOp->getType())
Craig Topperbb4069e2017-07-07 23:16:26 +00003662 RHSOp = Builder.CreateBitCast(RHSOp, LHSCIOp->getType());
Michael Liaod266b922015-02-13 04:51:26 +00003663 }
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003664 } else if (auto *RHSC = dyn_cast<Constant>(ICmp.getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003665 RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003666 }
Chris Lattner2188e402010-01-04 07:37:31 +00003667
3668 if (RHSOp)
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003669 return new ICmpInst(ICmp.getPredicate(), LHSCIOp, RHSOp);
Chris Lattner2188e402010-01-04 07:37:31 +00003670 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003671
Chris Lattner2188e402010-01-04 07:37:31 +00003672 // The code below only handles extension cast instructions, so far.
3673 // Enforce this.
3674 if (LHSCI->getOpcode() != Instruction::ZExt &&
3675 LHSCI->getOpcode() != Instruction::SExt)
Craig Topperf40110f2014-04-25 05:29:35 +00003676 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003677
3678 bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003679 bool isSignedCmp = ICmp.isSigned();
Chris Lattner2188e402010-01-04 07:37:31 +00003680
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003681 if (auto *CI = dyn_cast<CastInst>(ICmp.getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003682 // Not an extension from the same type?
3683 RHSCIOp = CI->getOperand(0);
Jim Grosbach129c52a2011-09-30 18:09:53 +00003684 if (RHSCIOp->getType() != LHSCIOp->getType())
Craig Topperf40110f2014-04-25 05:29:35 +00003685 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003686
Chris Lattner2188e402010-01-04 07:37:31 +00003687 // If the signedness of the two casts doesn't agree (i.e. one is a sext
3688 // and the other is a zext), then we can't handle this.
3689 if (CI->getOpcode() != LHSCI->getOpcode())
Craig Topperf40110f2014-04-25 05:29:35 +00003690 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003691
3692 // Deal with equality cases early.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003693 if (ICmp.isEquality())
3694 return new ICmpInst(ICmp.getPredicate(), LHSCIOp, RHSCIOp);
Chris Lattner2188e402010-01-04 07:37:31 +00003695
3696 // A signed comparison of sign extended values simplifies into a
3697 // signed comparison.
3698 if (isSignedCmp && isSignedExt)
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003699 return new ICmpInst(ICmp.getPredicate(), LHSCIOp, RHSCIOp);
Chris Lattner2188e402010-01-04 07:37:31 +00003700
3701 // The other three cases all fold into an unsigned comparison.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003702 return new ICmpInst(ICmp.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
Chris Lattner2188e402010-01-04 07:37:31 +00003703 }
3704
Sanjay Patel4c204232016-06-04 20:39:22 +00003705 // If we aren't dealing with a constant on the RHS, exit early.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003706 auto *C = dyn_cast<Constant>(ICmp.getOperand(1));
3707 if (!C)
Craig Topperf40110f2014-04-25 05:29:35 +00003708 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003709
3710 // Compute the constant that would happen if we truncated to SrcTy then
Sanjay Patelc774f8c2016-06-04 21:20:44 +00003711 // re-extended to DestTy.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003712 Constant *Res1 = ConstantExpr::getTrunc(C, SrcTy);
Sanjay Patelc774f8c2016-06-04 21:20:44 +00003713 Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(), Res1, DestTy);
Chris Lattner2188e402010-01-04 07:37:31 +00003714
3715 // If the re-extended constant didn't change...
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003716 if (Res2 == C) {
Chris Lattner2188e402010-01-04 07:37:31 +00003717 // Deal with equality cases early.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003718 if (ICmp.isEquality())
3719 return new ICmpInst(ICmp.getPredicate(), LHSCIOp, Res1);
Chris Lattner2188e402010-01-04 07:37:31 +00003720
3721 // A signed comparison of sign extended values simplifies into a
3722 // signed comparison.
3723 if (isSignedExt && isSignedCmp)
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003724 return new ICmpInst(ICmp.getPredicate(), LHSCIOp, Res1);
Chris Lattner2188e402010-01-04 07:37:31 +00003725
3726 // The other three cases all fold into an unsigned comparison.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003727 return new ICmpInst(ICmp.getUnsignedPredicate(), LHSCIOp, Res1);
Chris Lattner2188e402010-01-04 07:37:31 +00003728 }
3729
Sanjay Patel6a333c32016-06-06 16:56:57 +00003730 // The re-extended constant changed, partly changed (in the case of a vector),
3731 // or could not be determined to be equal (in the case of a constant
3732 // expression), so the constant cannot be represented in the shorter type.
3733 // Consequently, we cannot emit a simple comparison.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003734 // All the cases that fold to true or false will have already been handled
3735 // by SimplifyICmpInst, so only deal with the tricky case.
Chris Lattner2188e402010-01-04 07:37:31 +00003736
Sanjay Patel6a333c32016-06-06 16:56:57 +00003737 if (isSignedCmp || !isSignedExt || !isa<ConstantInt>(C))
Craig Topperf40110f2014-04-25 05:29:35 +00003738 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003739
3740 // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
3741 // should have been folded away previously and not enter in here.
Duncan Sands8fb2c382011-01-20 13:21:55 +00003742
3743 // We're performing an unsigned comp with a sign extended value.
3744 // This is true if the input is >= 0. [aka >s -1]
3745 Constant *NegOne = Constant::getAllOnesValue(SrcTy);
Craig Topperbb4069e2017-07-07 23:16:26 +00003746 Value *Result = Builder.CreateICmpSGT(LHSCIOp, NegOne, ICmp.getName());
Chris Lattner2188e402010-01-04 07:37:31 +00003747
3748 // Finally, return the value computed.
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003749 if (ICmp.getPredicate() == ICmpInst::ICMP_ULT)
3750 return replaceInstUsesWith(ICmp, Result);
Chris Lattner2188e402010-01-04 07:37:31 +00003751
Sanjay Patel6f8f47b2016-06-05 00:12:32 +00003752 assert(ICmp.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
Chris Lattner2188e402010-01-04 07:37:31 +00003753 return BinaryOperator::CreateNot(Result);
3754}
3755
Sanjoy Dasb0984472015-04-08 04:27:22 +00003756bool InstCombiner::OptimizeOverflowCheck(OverflowCheckFlavor OCF, Value *LHS,
3757 Value *RHS, Instruction &OrigI,
3758 Value *&Result, Constant *&Overflow) {
Sanjoy Das827529e2015-08-11 21:33:55 +00003759 if (OrigI.isCommutative() && isa<Constant>(LHS) && !isa<Constant>(RHS))
3760 std::swap(LHS, RHS);
Sanjoy Dasb0984472015-04-08 04:27:22 +00003761
3762 auto SetResult = [&](Value *OpResult, Constant *OverflowVal, bool ReuseName) {
3763 Result = OpResult;
3764 Overflow = OverflowVal;
3765 if (ReuseName)
3766 Result->takeName(&OrigI);
3767 return true;
3768 };
3769
Sanjoy Das6f5dca72015-08-28 19:09:31 +00003770 // If the overflow check was an add followed by a compare, the insertion point
3771 // may be pointing to the compare. We want to insert the new instructions
3772 // before the add in case there are uses of the add between the add and the
3773 // compare.
Craig Topperbb4069e2017-07-07 23:16:26 +00003774 Builder.SetInsertPoint(&OrigI);
Sanjoy Das6f5dca72015-08-28 19:09:31 +00003775
Sanjoy Dasb0984472015-04-08 04:27:22 +00003776 switch (OCF) {
3777 case OCF_INVALID:
3778 llvm_unreachable("bad overflow check kind!");
3779
3780 case OCF_UNSIGNED_ADD: {
3781 OverflowResult OR = computeOverflowForUnsignedAdd(LHS, RHS, &OrigI);
3782 if (OR == OverflowResult::NeverOverflows)
Craig Topperbb4069e2017-07-07 23:16:26 +00003783 return SetResult(Builder.CreateNUWAdd(LHS, RHS), Builder.getFalse(),
Sanjoy Dasb0984472015-04-08 04:27:22 +00003784 true);
3785
3786 if (OR == OverflowResult::AlwaysOverflows)
Craig Topperbb4069e2017-07-07 23:16:26 +00003787 return SetResult(Builder.CreateAdd(LHS, RHS), Builder.getTrue(), true);
Justin Bognercd1d5aa2016-08-17 20:30:52 +00003788
3789 // Fall through uadd into sadd
3790 LLVM_FALLTHROUGH;
Sanjoy Dasb0984472015-04-08 04:27:22 +00003791 }
Sanjoy Dasb0984472015-04-08 04:27:22 +00003792 case OCF_SIGNED_ADD: {
David Majnemer27e89ba2015-05-21 23:04:21 +00003793 // X + 0 -> {X, false}
3794 if (match(RHS, m_Zero()))
Craig Topperbb4069e2017-07-07 23:16:26 +00003795 return SetResult(LHS, Builder.getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00003796
3797 // We can strength reduce this signed add into a regular add if we can prove
3798 // that it will never overflow.
3799 if (OCF == OCF_SIGNED_ADD)
Craig Topper2b1fc322017-05-22 06:25:31 +00003800 if (willNotOverflowSignedAdd(LHS, RHS, OrigI))
Craig Topperbb4069e2017-07-07 23:16:26 +00003801 return SetResult(Builder.CreateNSWAdd(LHS, RHS), Builder.getFalse(),
Sanjoy Dasb0984472015-04-08 04:27:22 +00003802 true);
Sanjoy Das72cb5e12015-06-05 18:04:42 +00003803 break;
Sanjoy Dasb0984472015-04-08 04:27:22 +00003804 }
3805
3806 case OCF_UNSIGNED_SUB:
3807 case OCF_SIGNED_SUB: {
David Majnemer27e89ba2015-05-21 23:04:21 +00003808 // X - 0 -> {X, false}
3809 if (match(RHS, m_Zero()))
Craig Topperbb4069e2017-07-07 23:16:26 +00003810 return SetResult(LHS, Builder.getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00003811
3812 if (OCF == OCF_SIGNED_SUB) {
Craig Topper2b1fc322017-05-22 06:25:31 +00003813 if (willNotOverflowSignedSub(LHS, RHS, OrigI))
Craig Topperbb4069e2017-07-07 23:16:26 +00003814 return SetResult(Builder.CreateNSWSub(LHS, RHS), Builder.getFalse(),
Sanjoy Dasb0984472015-04-08 04:27:22 +00003815 true);
3816 } else {
Craig Topper2b1fc322017-05-22 06:25:31 +00003817 if (willNotOverflowUnsignedSub(LHS, RHS, OrigI))
Craig Topperbb4069e2017-07-07 23:16:26 +00003818 return SetResult(Builder.CreateNUWSub(LHS, RHS), Builder.getFalse(),
Sanjoy Dasb0984472015-04-08 04:27:22 +00003819 true);
3820 }
3821 break;
3822 }
3823
3824 case OCF_UNSIGNED_MUL: {
3825 OverflowResult OR = computeOverflowForUnsignedMul(LHS, RHS, &OrigI);
3826 if (OR == OverflowResult::NeverOverflows)
Craig Topperbb4069e2017-07-07 23:16:26 +00003827 return SetResult(Builder.CreateNUWMul(LHS, RHS), Builder.getFalse(),
Sanjoy Dasb0984472015-04-08 04:27:22 +00003828 true);
3829 if (OR == OverflowResult::AlwaysOverflows)
Craig Topperbb4069e2017-07-07 23:16:26 +00003830 return SetResult(Builder.CreateMul(LHS, RHS), Builder.getTrue(), true);
Justin Bognercd1d5aa2016-08-17 20:30:52 +00003831 LLVM_FALLTHROUGH;
3832 }
Sanjoy Dasb0984472015-04-08 04:27:22 +00003833 case OCF_SIGNED_MUL:
3834 // X * undef -> undef
3835 if (isa<UndefValue>(RHS))
Craig Topperbb4069e2017-07-07 23:16:26 +00003836 return SetResult(RHS, UndefValue::get(Builder.getInt1Ty()), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00003837
David Majnemer27e89ba2015-05-21 23:04:21 +00003838 // X * 0 -> {0, false}
3839 if (match(RHS, m_Zero()))
Craig Topperbb4069e2017-07-07 23:16:26 +00003840 return SetResult(RHS, Builder.getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00003841
David Majnemer27e89ba2015-05-21 23:04:21 +00003842 // X * 1 -> {X, false}
3843 if (match(RHS, m_One()))
Craig Topperbb4069e2017-07-07 23:16:26 +00003844 return SetResult(LHS, Builder.getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00003845
3846 if (OCF == OCF_SIGNED_MUL)
Craig Topper2b1fc322017-05-22 06:25:31 +00003847 if (willNotOverflowSignedMul(LHS, RHS, OrigI))
Craig Topperbb4069e2017-07-07 23:16:26 +00003848 return SetResult(Builder.CreateNSWMul(LHS, RHS), Builder.getFalse(),
Sanjoy Dasb0984472015-04-08 04:27:22 +00003849 true);
Sanjoy Dasc80dad62015-06-05 18:04:46 +00003850 break;
Sanjoy Dasb0984472015-04-08 04:27:22 +00003851 }
3852
3853 return false;
3854}
3855
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00003856/// Recognize and process idiom involving test for multiplication
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003857/// overflow.
3858///
3859/// The caller has matched a pattern of the form:
3860/// I = cmp u (mul(zext A, zext B), V
3861/// The function checks if this is a test for overflow and if so replaces
3862/// multiplication with call to 'mul.with.overflow' intrinsic.
3863///
3864/// \param I Compare instruction.
3865/// \param MulVal Result of 'mult' instruction. It is one of the arguments of
3866/// the compare instruction. Must be of integer type.
3867/// \param OtherVal The other argument of compare instruction.
3868/// \returns Instruction which must replace the compare instruction, NULL if no
3869/// replacement required.
Sanjay Pateld93c4c02016-09-15 18:22:25 +00003870static Instruction *processUMulZExtIdiom(ICmpInst &I, Value *MulVal,
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003871 Value *OtherVal, InstCombiner &IC) {
Benjamin Kramerc96a7f82014-06-24 10:47:52 +00003872 // Don't bother doing this transformation for pointers, don't do it for
3873 // vectors.
3874 if (!isa<IntegerType>(MulVal->getType()))
3875 return nullptr;
3876
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003877 assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal);
3878 assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal);
David Majnemerdaa24b92015-09-05 20:44:56 +00003879 auto *MulInstr = dyn_cast<Instruction>(MulVal);
3880 if (!MulInstr)
3881 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003882 assert(MulInstr->getOpcode() == Instruction::Mul);
3883
David Majnemer634ca232014-11-01 23:46:05 +00003884 auto *LHS = cast<ZExtOperator>(MulInstr->getOperand(0)),
3885 *RHS = cast<ZExtOperator>(MulInstr->getOperand(1));
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003886 assert(LHS->getOpcode() == Instruction::ZExt);
3887 assert(RHS->getOpcode() == Instruction::ZExt);
3888 Value *A = LHS->getOperand(0), *B = RHS->getOperand(0);
3889
3890 // Calculate type and width of the result produced by mul.with.overflow.
3891 Type *TyA = A->getType(), *TyB = B->getType();
3892 unsigned WidthA = TyA->getPrimitiveSizeInBits(),
3893 WidthB = TyB->getPrimitiveSizeInBits();
3894 unsigned MulWidth;
3895 Type *MulType;
3896 if (WidthB > WidthA) {
3897 MulWidth = WidthB;
3898 MulType = TyB;
3899 } else {
3900 MulWidth = WidthA;
3901 MulType = TyA;
3902 }
3903
3904 // In order to replace the original mul with a narrower mul.with.overflow,
3905 // all uses must ignore upper bits of the product. The number of used low
3906 // bits must be not greater than the width of mul.with.overflow.
3907 if (MulVal->hasNUsesOrMore(2))
3908 for (User *U : MulVal->users()) {
3909 if (U == &I)
3910 continue;
3911 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
3912 // Check if truncation ignores bits above MulWidth.
3913 unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits();
3914 if (TruncWidth > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00003915 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003916 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
3917 // Check if AND ignores bits above MulWidth.
3918 if (BO->getOpcode() != Instruction::And)
Craig Topperf40110f2014-04-25 05:29:35 +00003919 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003920 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
3921 const APInt &CVal = CI->getValue();
3922 if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00003923 return nullptr;
Davide Italiano579064e2017-07-16 18:56:30 +00003924 } else {
3925 // In this case we could have the operand of the binary operation
3926 // being defined in another block, and performing the replacement
3927 // could break the dominance relation.
3928 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003929 }
3930 } else {
3931 // Other uses prohibit this transformation.
Craig Topperf40110f2014-04-25 05:29:35 +00003932 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003933 }
3934 }
3935
3936 // Recognize patterns
3937 switch (I.getPredicate()) {
3938 case ICmpInst::ICMP_EQ:
3939 case ICmpInst::ICMP_NE:
3940 // Recognize pattern:
3941 // mulval = mul(zext A, zext B)
3942 // cmp eq/neq mulval, zext trunc mulval
3943 if (ZExtInst *Zext = dyn_cast<ZExtInst>(OtherVal))
3944 if (Zext->hasOneUse()) {
3945 Value *ZextArg = Zext->getOperand(0);
3946 if (TruncInst *Trunc = dyn_cast<TruncInst>(ZextArg))
3947 if (Trunc->getType()->getPrimitiveSizeInBits() == MulWidth)
3948 break; //Recognized
3949 }
3950
3951 // Recognize pattern:
3952 // mulval = mul(zext A, zext B)
3953 // cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits.
3954 ConstantInt *CI;
3955 Value *ValToMask;
3956 if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) {
3957 if (ValToMask != MulVal)
Craig Topperf40110f2014-04-25 05:29:35 +00003958 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003959 const APInt &CVal = CI->getValue() + 1;
3960 if (CVal.isPowerOf2()) {
3961 unsigned MaskWidth = CVal.logBase2();
3962 if (MaskWidth == MulWidth)
3963 break; // Recognized
3964 }
3965 }
Craig Topperf40110f2014-04-25 05:29:35 +00003966 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003967
3968 case ICmpInst::ICMP_UGT:
3969 // Recognize pattern:
3970 // mulval = mul(zext A, zext B)
3971 // cmp ugt mulval, max
3972 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
3973 APInt MaxVal = APInt::getMaxValue(MulWidth);
3974 MaxVal = MaxVal.zext(CI->getBitWidth());
3975 if (MaxVal.eq(CI->getValue()))
3976 break; // Recognized
3977 }
Craig Topperf40110f2014-04-25 05:29:35 +00003978 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003979
3980 case ICmpInst::ICMP_UGE:
3981 // Recognize pattern:
3982 // mulval = mul(zext A, zext B)
3983 // cmp uge mulval, max+1
3984 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
3985 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
3986 if (MaxVal.eq(CI->getValue()))
3987 break; // Recognized
3988 }
Craig Topperf40110f2014-04-25 05:29:35 +00003989 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003990
3991 case ICmpInst::ICMP_ULE:
3992 // Recognize pattern:
3993 // mulval = mul(zext A, zext B)
3994 // cmp ule mulval, max
3995 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
3996 APInt MaxVal = APInt::getMaxValue(MulWidth);
3997 MaxVal = MaxVal.zext(CI->getBitWidth());
3998 if (MaxVal.eq(CI->getValue()))
3999 break; // Recognized
4000 }
Craig Topperf40110f2014-04-25 05:29:35 +00004001 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004002
4003 case ICmpInst::ICMP_ULT:
4004 // Recognize pattern:
4005 // mulval = mul(zext A, zext B)
4006 // cmp ule mulval, max + 1
4007 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00004008 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004009 if (MaxVal.eq(CI->getValue()))
4010 break; // Recognized
4011 }
Craig Topperf40110f2014-04-25 05:29:35 +00004012 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004013
4014 default:
Craig Topperf40110f2014-04-25 05:29:35 +00004015 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004016 }
4017
Craig Topperbb4069e2017-07-07 23:16:26 +00004018 InstCombiner::BuilderTy &Builder = IC.Builder;
4019 Builder.SetInsertPoint(MulInstr);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004020
4021 // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B)
4022 Value *MulA = A, *MulB = B;
4023 if (WidthA < MulWidth)
Craig Topperbb4069e2017-07-07 23:16:26 +00004024 MulA = Builder.CreateZExt(A, MulType);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004025 if (WidthB < MulWidth)
Craig Topperbb4069e2017-07-07 23:16:26 +00004026 MulB = Builder.CreateZExt(B, MulType);
Sanjay Patelaf674fb2015-12-14 17:24:23 +00004027 Value *F = Intrinsic::getDeclaration(I.getModule(),
4028 Intrinsic::umul_with_overflow, MulType);
Craig Topperbb4069e2017-07-07 23:16:26 +00004029 CallInst *Call = Builder.CreateCall(F, {MulA, MulB}, "umul");
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004030 IC.Worklist.Add(MulInstr);
4031
4032 // If there are uses of mul result other than the comparison, we know that
4033 // they are truncation or binary AND. Change them to use result of
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00004034 // mul.with.overflow and adjust properly mask/size.
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004035 if (MulVal->hasNUsesOrMore(2)) {
Craig Topperbb4069e2017-07-07 23:16:26 +00004036 Value *Mul = Builder.CreateExtractValue(Call, 0, "umul.value");
Joseph Tremoulet6f406d42018-06-15 16:52:40 +00004037 for (auto UI = MulVal->user_begin(), UE = MulVal->user_end(); UI != UE;) {
4038 User *U = *UI++;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004039 if (U == &I || U == OtherVal)
4040 continue;
4041 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
4042 if (TI->getType()->getPrimitiveSizeInBits() == MulWidth)
Sanjay Patel4b198802016-02-01 22:23:39 +00004043 IC.replaceInstUsesWith(*TI, Mul);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004044 else
4045 TI->setOperand(0, Mul);
4046 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
4047 assert(BO->getOpcode() == Instruction::And);
4048 // Replace (mul & mask) --> zext (mul.with.overflow & short_mask)
Davide Italiano579064e2017-07-16 18:56:30 +00004049 ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
4050 APInt ShortMask = CI->getValue().trunc(MulWidth);
Craig Topperbb4069e2017-07-07 23:16:26 +00004051 Value *ShortAnd = Builder.CreateAnd(Mul, ShortMask);
Davide Italiano579064e2017-07-16 18:56:30 +00004052 Instruction *Zext =
4053 cast<Instruction>(Builder.CreateZExt(ShortAnd, BO->getType()));
4054 IC.Worklist.Add(Zext);
Sanjay Patel4b198802016-02-01 22:23:39 +00004055 IC.replaceInstUsesWith(*BO, Zext);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004056 } else {
4057 llvm_unreachable("Unexpected Binary operation");
4058 }
Davide Italiano579064e2017-07-16 18:56:30 +00004059 IC.Worklist.Add(cast<Instruction>(U));
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004060 }
4061 }
4062 if (isa<Instruction>(OtherVal))
4063 IC.Worklist.Add(cast<Instruction>(OtherVal));
4064
4065 // The original icmp gets replaced with the overflow value, maybe inverted
4066 // depending on predicate.
4067 bool Inverse = false;
4068 switch (I.getPredicate()) {
4069 case ICmpInst::ICMP_NE:
4070 break;
4071 case ICmpInst::ICMP_EQ:
4072 Inverse = true;
4073 break;
4074 case ICmpInst::ICMP_UGT:
4075 case ICmpInst::ICMP_UGE:
4076 if (I.getOperand(0) == MulVal)
4077 break;
4078 Inverse = true;
4079 break;
4080 case ICmpInst::ICMP_ULT:
4081 case ICmpInst::ICMP_ULE:
4082 if (I.getOperand(1) == MulVal)
4083 break;
4084 Inverse = true;
4085 break;
4086 default:
4087 llvm_unreachable("Unexpected predicate");
4088 }
4089 if (Inverse) {
Craig Topperbb4069e2017-07-07 23:16:26 +00004090 Value *Res = Builder.CreateExtractValue(Call, 1);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004091 return BinaryOperator::CreateNot(Res);
4092 }
4093
4094 return ExtractValueInst::Create(Call, 1);
4095}
4096
Sanjay Patel5f0217f2016-06-05 16:46:18 +00004097/// When performing a comparison against a constant, it is possible that not all
4098/// the bits in the LHS are demanded. This helper method computes the mask that
4099/// IS demanded.
Craig Topper3edda872017-09-22 18:57:23 +00004100static APInt getDemandedBitsLHSMask(ICmpInst &I, unsigned BitWidth) {
Craig Topper18887bf2017-09-20 23:48:58 +00004101 const APInt *RHS;
4102 if (!match(I.getOperand(1), m_APInt(RHS)))
4103 return APInt::getAllOnesValue(BitWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +00004104
Craig Topper3edda872017-09-22 18:57:23 +00004105 // If this is a normal comparison, it demands all bits. If it is a sign bit
4106 // comparison, it only demands the sign bit.
4107 bool UnusedBit;
4108 if (isSignBitCheck(I.getPredicate(), *RHS, UnusedBit))
4109 return APInt::getSignMask(BitWidth);
4110
Owen Andersond490c2d2011-01-11 00:36:45 +00004111 switch (I.getPredicate()) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00004112 // For a UGT comparison, we don't care about any bits that
Owen Andersond490c2d2011-01-11 00:36:45 +00004113 // correspond to the trailing ones of the comparand. The value of these
4114 // bits doesn't impact the outcome of the comparison, because any value
4115 // greater than the RHS must differ in a bit higher than these due to carry.
Craig Topper18887bf2017-09-20 23:48:58 +00004116 case ICmpInst::ICMP_UGT:
4117 return APInt::getBitsSetFrom(BitWidth, RHS->countTrailingOnes());
Jim Grosbach129c52a2011-09-30 18:09:53 +00004118
Owen Andersond490c2d2011-01-11 00:36:45 +00004119 // Similarly, for a ULT comparison, we don't care about the trailing zeros.
4120 // Any value less than the RHS must differ in a higher bit because of carries.
Craig Topper18887bf2017-09-20 23:48:58 +00004121 case ICmpInst::ICMP_ULT:
4122 return APInt::getBitsSetFrom(BitWidth, RHS->countTrailingZeros());
Jim Grosbach129c52a2011-09-30 18:09:53 +00004123
Owen Andersond490c2d2011-01-11 00:36:45 +00004124 default:
4125 return APInt::getAllOnesValue(BitWidth);
4126 }
Owen Andersond490c2d2011-01-11 00:36:45 +00004127}
Chris Lattner2188e402010-01-04 07:37:31 +00004128
Sanjay Patel4ccae1c2018-02-02 18:39:05 +00004129/// Check if the order of \p Op0 and \p Op1 as operands in an ICmpInst
Quentin Colombet5ab55552013-09-09 20:56:48 +00004130/// should be swapped.
Alp Tokercb402912014-01-24 17:20:08 +00004131/// The decision is based on how many times these two operands are reused
Quentin Colombet5ab55552013-09-09 20:56:48 +00004132/// as subtract operands and their positions in those instructions.
Sanjay Patel4ccae1c2018-02-02 18:39:05 +00004133/// The rationale is that several architectures use the same instruction for
4134/// both subtract and cmp. Thus, it is better if the order of those operands
Quentin Colombet5ab55552013-09-09 20:56:48 +00004135/// match.
4136/// \return true if Op0 and Op1 should be swapped.
Sanjay Patel4ccae1c2018-02-02 18:39:05 +00004137static bool swapMayExposeCSEOpportunities(const Value *Op0, const Value *Op1) {
4138 // Filter out pointer values as those cannot appear directly in subtract.
Quentin Colombet5ab55552013-09-09 20:56:48 +00004139 // FIXME: we may want to go through inttoptrs or bitcasts.
4140 if (Op0->getType()->isPointerTy())
4141 return false;
Sanjay Patel1ea86972018-02-02 19:08:12 +00004142 // If a subtract already has the same operands as a compare, swapping would be
4143 // bad. If a subtract has the same operands as a compare but in reverse order,
4144 // then swapping is good.
4145 int GoodToSwap = 0;
Chandler Carruthcdf47882014-03-09 03:16:01 +00004146 for (const User *U : Op0->users()) {
Sanjay Patel1ea86972018-02-02 19:08:12 +00004147 if (match(U, m_Sub(m_Specific(Op1), m_Specific(Op0))))
4148 GoodToSwap++;
4149 else if (match(U, m_Sub(m_Specific(Op0), m_Specific(Op1))))
4150 GoodToSwap--;
Quentin Colombet5ab55552013-09-09 20:56:48 +00004151 }
Sanjay Patel1ea86972018-02-02 19:08:12 +00004152 return GoodToSwap > 0;
Quentin Colombet5ab55552013-09-09 20:56:48 +00004153}
4154
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00004155/// Check that one use is in the same block as the definition and all
Sanjay Patel53523312016-09-12 14:25:46 +00004156/// other uses are in blocks dominated by a given block.
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004157///
4158/// \param DI Definition
4159/// \param UI Use
4160/// \param DB Block that must dominate all uses of \p DI outside
4161/// the parent block
4162/// \return true when \p UI is the only use of \p DI in the parent block
4163/// and all other uses of \p DI are in blocks dominated by \p DB.
4164///
4165bool InstCombiner::dominatesAllUses(const Instruction *DI,
4166 const Instruction *UI,
4167 const BasicBlock *DB) const {
4168 assert(DI && UI && "Instruction not defined\n");
Sanjay Patel53523312016-09-12 14:25:46 +00004169 // Ignore incomplete definitions.
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004170 if (!DI->getParent())
4171 return false;
Sanjay Patel53523312016-09-12 14:25:46 +00004172 // DI and UI must be in the same block.
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004173 if (DI->getParent() != UI->getParent())
4174 return false;
Sanjay Patel53523312016-09-12 14:25:46 +00004175 // Protect from self-referencing blocks.
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004176 if (DI->getParent() == DB)
4177 return false;
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004178 for (const User *U : DI->users()) {
4179 auto *Usr = cast<Instruction>(U);
Justin Bogner99798402016-08-05 01:06:44 +00004180 if (Usr != UI && !DT.dominates(DB, Usr->getParent()))
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004181 return false;
4182 }
4183 return true;
4184}
4185
Sanjay Patel5f0217f2016-06-05 16:46:18 +00004186/// Return true when the instruction sequence within a block is select-cmp-br.
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004187static bool isChainSelectCmpBranch(const SelectInst *SI) {
4188 const BasicBlock *BB = SI->getParent();
4189 if (!BB)
4190 return false;
4191 auto *BI = dyn_cast_or_null<BranchInst>(BB->getTerminator());
4192 if (!BI || BI->getNumSuccessors() != 2)
4193 return false;
4194 auto *IC = dyn_cast<ICmpInst>(BI->getCondition());
4195 if (!IC || (IC->getOperand(0) != SI && IC->getOperand(1) != SI))
4196 return false;
4197 return true;
4198}
4199
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00004200/// True when a select result is replaced by one of its operands
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004201/// in select-icmp sequence. This will eventually result in the elimination
4202/// of the select.
4203///
4204/// \param SI Select instruction
4205/// \param Icmp Compare instruction
4206/// \param SIOpd Operand that replaces the select
4207///
4208/// Notes:
4209/// - The replacement is global and requires dominator information
4210/// - The caller is responsible for the actual replacement
4211///
4212/// Example:
4213///
4214/// entry:
4215/// %4 = select i1 %3, %C* %0, %C* null
4216/// %5 = icmp eq %C* %4, null
4217/// br i1 %5, label %9, label %7
4218/// ...
4219/// ; <label>:7 ; preds = %entry
4220/// %8 = getelementptr inbounds %C* %4, i64 0, i32 0
4221/// ...
4222///
4223/// can be transformed to
4224///
4225/// %5 = icmp eq %C* %0, null
4226/// %6 = select i1 %3, i1 %5, i1 true
4227/// br i1 %6, label %9, label %7
4228/// ...
4229/// ; <label>:7 ; preds = %entry
4230/// %8 = getelementptr inbounds %C* %0, i64 0, i32 0 // replace by %0!
4231///
4232/// Similar when the first operand of the select is a constant or/and
4233/// the compare is for not equal rather than equal.
4234///
4235/// NOTE: The function is only called when the select and compare constants
4236/// are equal, the optimization can work only for EQ predicates. This is not a
4237/// major restriction since a NE compare should be 'normalized' to an equal
4238/// compare, which usually happens in the combiner and test case
Sanjay Patel53523312016-09-12 14:25:46 +00004239/// select-cmp-br.ll checks for it.
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004240bool InstCombiner::replacedSelectWithOperand(SelectInst *SI,
4241 const ICmpInst *Icmp,
4242 const unsigned SIOpd) {
David Majnemer83484fd2014-11-22 06:09:28 +00004243 assert((SIOpd == 1 || SIOpd == 2) && "Invalid select operand!");
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004244 if (isChainSelectCmpBranch(SI) && Icmp->getPredicate() == ICmpInst::ICMP_EQ) {
4245 BasicBlock *Succ = SI->getParent()->getTerminator()->getSuccessor(1);
Bjorn Petterssone5027cf2017-03-02 15:18:58 +00004246 // The check for the single predecessor is not the best that can be
Sanjay Patel53523312016-09-12 14:25:46 +00004247 // done. But it protects efficiently against cases like when SI's
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004248 // home block has two successors, Succ and Succ1, and Succ1 predecessor
4249 // of Succ. Then SI can't be replaced by SIOpd because the use that gets
4250 // replaced can be reached on either path. So the uniqueness check
4251 // guarantees that the path all uses of SI (outside SI's parent) are on
4252 // is disjoint from all other paths out of SI. But that information
4253 // is more expensive to compute, and the trade-off here is in favor
Bjorn Petterssone5027cf2017-03-02 15:18:58 +00004254 // of compile-time. It should also be noticed that we check for a single
4255 // predecessor and not only uniqueness. This to handle the situation when
4256 // Succ and Succ1 points to the same basic block.
4257 if (Succ->getSinglePredecessor() && dominatesAllUses(SI, Icmp, Succ)) {
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00004258 NumSel++;
4259 SI->replaceUsesOutsideBlock(SI->getOperand(SIOpd), SI->getParent());
4260 return true;
4261 }
4262 }
4263 return false;
4264}
4265
Sanjay Patel3151dec2016-09-12 15:24:31 +00004266/// Try to fold the comparison based on range information we can get by checking
4267/// whether bits are known to be zero or one in the inputs.
4268Instruction *InstCombiner::foldICmpUsingKnownBits(ICmpInst &I) {
4269 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
4270 Type *Ty = Op0->getType();
Sanjay Patel0531f0a2016-09-12 15:52:28 +00004271 ICmpInst::Predicate Pred = I.getPredicate();
Sanjay Patel3151dec2016-09-12 15:24:31 +00004272
4273 // Get scalar or pointer size.
4274 unsigned BitWidth = Ty->isIntOrIntVectorTy()
4275 ? Ty->getScalarSizeInBits()
Elena Demikhovsky945b7e52018-02-14 06:58:08 +00004276 : DL.getIndexTypeSizeInBits(Ty->getScalarType());
Sanjay Patel3151dec2016-09-12 15:24:31 +00004277
4278 if (!BitWidth)
4279 return nullptr;
4280
Craig Topperb45eabc2017-04-26 16:39:58 +00004281 KnownBits Op0Known(BitWidth);
4282 KnownBits Op1Known(BitWidth);
Sanjay Patel3151dec2016-09-12 15:24:31 +00004283
Craig Topper47596dd2017-03-25 06:52:52 +00004284 if (SimplifyDemandedBits(&I, 0,
Craig Topper3edda872017-09-22 18:57:23 +00004285 getDemandedBitsLHSMask(I, BitWidth),
Craig Topperb45eabc2017-04-26 16:39:58 +00004286 Op0Known, 0))
Sanjay Patel3151dec2016-09-12 15:24:31 +00004287 return &I;
4288
Craig Topper47596dd2017-03-25 06:52:52 +00004289 if (SimplifyDemandedBits(&I, 1, APInt::getAllOnesValue(BitWidth),
Craig Topperb45eabc2017-04-26 16:39:58 +00004290 Op1Known, 0))
Sanjay Patel3151dec2016-09-12 15:24:31 +00004291 return &I;
4292
4293 // Given the known and unknown bits, compute a range that the LHS could be
4294 // in. Compute the Min, Max and RHS values based on the known bits. For the
4295 // EQ and NE we use unsigned values.
4296 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
4297 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
4298 if (I.isSigned()) {
Craig Topperb45eabc2017-04-26 16:39:58 +00004299 computeSignedMinMaxValuesFromKnownBits(Op0Known, Op0Min, Op0Max);
4300 computeSignedMinMaxValuesFromKnownBits(Op1Known, Op1Min, Op1Max);
Sanjay Patel3151dec2016-09-12 15:24:31 +00004301 } else {
Craig Topperb45eabc2017-04-26 16:39:58 +00004302 computeUnsignedMinMaxValuesFromKnownBits(Op0Known, Op0Min, Op0Max);
4303 computeUnsignedMinMaxValuesFromKnownBits(Op1Known, Op1Min, Op1Max);
Sanjay Patel3151dec2016-09-12 15:24:31 +00004304 }
4305
Sanjay Patelc63f9012018-01-04 14:31:56 +00004306 // If Min and Max are known to be the same, then SimplifyDemandedBits figured
4307 // out that the LHS or RHS is a constant. Constant fold this now, so that
Sanjay Patel0531f0a2016-09-12 15:52:28 +00004308 // code below can assume that Min != Max.
Sanjay Patel3151dec2016-09-12 15:24:31 +00004309 if (!isa<Constant>(Op0) && Op0Min == Op0Max)
Sanjay Patelc63f9012018-01-04 14:31:56 +00004310 return new ICmpInst(Pred, ConstantExpr::getIntegerValue(Ty, Op0Min), Op1);
Sanjay Patel3151dec2016-09-12 15:24:31 +00004311 if (!isa<Constant>(Op1) && Op1Min == Op1Max)
Sanjay Patelc63f9012018-01-04 14:31:56 +00004312 return new ICmpInst(Pred, Op0, ConstantExpr::getIntegerValue(Ty, Op1Min));
Sanjay Patel3151dec2016-09-12 15:24:31 +00004313
4314 // Based on the range information we know about the LHS, see if we can
4315 // simplify this comparison. For example, (x&4) < 8 is always true.
Sanjay Patel0531f0a2016-09-12 15:52:28 +00004316 switch (Pred) {
Sanjay Patel3151dec2016-09-12 15:24:31 +00004317 default:
4318 llvm_unreachable("Unknown icmp opcode!");
Sanjay Patel9efb1bd2016-09-14 23:38:56 +00004319 case ICmpInst::ICMP_EQ:
Sanjay Patel3151dec2016-09-12 15:24:31 +00004320 case ICmpInst::ICMP_NE: {
Sanjay Patel9efb1bd2016-09-14 23:38:56 +00004321 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max)) {
4322 return Pred == CmpInst::ICMP_EQ
4323 ? replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()))
4324 : replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
4325 }
Sanjay Patel3151dec2016-09-12 15:24:31 +00004326
Sanjay Patel0531f0a2016-09-12 15:52:28 +00004327 // If all bits are known zero except for one, then we know at most one bit
4328 // is set. If the comparison is against zero, then this is a check to see if
4329 // *that* bit is set.
Craig Topperb45eabc2017-04-26 16:39:58 +00004330 APInt Op0KnownZeroInverted = ~Op0Known.Zero;
Craig Topperf0aeee02017-05-05 17:36:09 +00004331 if (Op1Known.isZero()) {
Sanjay Patel3151dec2016-09-12 15:24:31 +00004332 // If the LHS is an AND with the same constant, look through it.
4333 Value *LHS = nullptr;
Sanjay Patel7577a3d2016-09-15 14:15:47 +00004334 const APInt *LHSC;
4335 if (!match(Op0, m_And(m_Value(LHS), m_APInt(LHSC))) ||
4336 *LHSC != Op0KnownZeroInverted)
Sanjay Patel3151dec2016-09-12 15:24:31 +00004337 LHS = Op0;
4338
Sanjay Patel9efb1bd2016-09-14 23:38:56 +00004339 Value *X;
Sanjay Patel3151dec2016-09-12 15:24:31 +00004340 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
4341 APInt ValToCheck = Op0KnownZeroInverted;
Sanjay Patel9efb1bd2016-09-14 23:38:56 +00004342 Type *XTy = X->getType();
Sanjay Patel3151dec2016-09-12 15:24:31 +00004343 if (ValToCheck.isPowerOf2()) {
Sanjay Patel9efb1bd2016-09-14 23:38:56 +00004344 // ((1 << X) & 8) == 0 -> X != 3
4345 // ((1 << X) & 8) != 0 -> X == 3
4346 auto *CmpC = ConstantInt::get(XTy, ValToCheck.countTrailingZeros());
4347 auto NewPred = ICmpInst::getInversePredicate(Pred);
4348 return new ICmpInst(NewPred, X, CmpC);
Sanjay Patel3151dec2016-09-12 15:24:31 +00004349 } else if ((++ValToCheck).isPowerOf2()) {
Sanjay Patel9efb1bd2016-09-14 23:38:56 +00004350 // ((1 << X) & 7) == 0 -> X >= 3
4351 // ((1 << X) & 7) != 0 -> X < 3
4352 auto *CmpC = ConstantInt::get(XTy, ValToCheck.countTrailingZeros());
4353 auto NewPred =
4354 Pred == CmpInst::ICMP_EQ ? CmpInst::ICMP_UGE : CmpInst::ICMP_ULT;
4355 return new ICmpInst(NewPred, X, CmpC);
Sanjay Patel3151dec2016-09-12 15:24:31 +00004356 }
4357 }
4358
Sanjay Patel9efb1bd2016-09-14 23:38:56 +00004359 // Check if the LHS is 8 >>u x and the result is a power of 2 like 1.
Sanjay Patel3151dec2016-09-12 15:24:31 +00004360 const APInt *CI;
Craig Topper73ba1c82017-06-07 07:40:37 +00004361 if (Op0KnownZeroInverted.isOneValue() &&
Sanjay Patel9efb1bd2016-09-14 23:38:56 +00004362 match(LHS, m_LShr(m_Power2(CI), m_Value(X)))) {
4363 // ((8 >>u X) & 1) == 0 -> X != 3
4364 // ((8 >>u X) & 1) != 0 -> X == 3
4365 unsigned CmpVal = CI->countTrailingZeros();
4366 auto NewPred = ICmpInst::getInversePredicate(Pred);
4367 return new ICmpInst(NewPred, X, ConstantInt::get(X->getType(), CmpVal));
4368 }
Sanjay Patel3151dec2016-09-12 15:24:31 +00004369 }
4370 break;
4371 }
4372 case ICmpInst::ICMP_ULT: {
4373 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
4374 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
4375 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
4376 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
4377 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
4378 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
4379
Craig Topper0cd25942017-09-27 22:57:18 +00004380 const APInt *CmpC;
4381 if (match(Op1, m_APInt(CmpC))) {
Sanjay Patel3151dec2016-09-12 15:24:31 +00004382 // A <u C -> A == C-1 if min(A)+1 == C
Craig Topper0cd25942017-09-27 22:57:18 +00004383 if (*CmpC == Op0Min + 1)
Craig Topper2c9b7d72017-09-22 18:57:20 +00004384 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Craig Topper0cd25942017-09-27 22:57:18 +00004385 ConstantInt::get(Op1->getType(), *CmpC - 1));
Craig Topper30dc9792017-09-25 21:15:00 +00004386 // X <u C --> X == 0, if the number of zero bits in the bottom of X
4387 // exceeds the log2 of C.
Craig Topper0cd25942017-09-27 22:57:18 +00004388 if (Op0Known.countMinTrailingZeros() >= CmpC->ceilLogBase2())
Craig Topper30dc9792017-09-25 21:15:00 +00004389 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
4390 Constant::getNullValue(Op1->getType()));
Sanjay Patel3151dec2016-09-12 15:24:31 +00004391 }
4392 break;
4393 }
4394 case ICmpInst::ICMP_UGT: {
4395 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
4396 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Sanjay Patel3151dec2016-09-12 15:24:31 +00004397 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
4398 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Sanjay Patel3151dec2016-09-12 15:24:31 +00004399 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
4400 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
4401
Craig Topper0cd25942017-09-27 22:57:18 +00004402 const APInt *CmpC;
4403 if (match(Op1, m_APInt(CmpC))) {
Sanjay Patel3151dec2016-09-12 15:24:31 +00004404 // A >u C -> A == C+1 if max(a)-1 == C
Craig Topper0cd25942017-09-27 22:57:18 +00004405 if (*CmpC == Op0Max - 1)
Sanjay Patel3151dec2016-09-12 15:24:31 +00004406 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Craig Topper0cd25942017-09-27 22:57:18 +00004407 ConstantInt::get(Op1->getType(), *CmpC + 1));
Craig Topper30dc9792017-09-25 21:15:00 +00004408 // X >u C --> X != 0, if the number of zero bits in the bottom of X
4409 // exceeds the log2 of C.
Craig Topper0cd25942017-09-27 22:57:18 +00004410 if (Op0Known.countMinTrailingZeros() >= CmpC->getActiveBits())
Craig Topper30dc9792017-09-25 21:15:00 +00004411 return new ICmpInst(ICmpInst::ICMP_NE, Op0,
4412 Constant::getNullValue(Op1->getType()));
Sanjay Patel3151dec2016-09-12 15:24:31 +00004413 }
4414 break;
4415 }
Craig Topper0cd25942017-09-27 22:57:18 +00004416 case ICmpInst::ICMP_SLT: {
Sanjay Patel3151dec2016-09-12 15:24:31 +00004417 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
4418 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
4419 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
4420 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
4421 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
4422 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
Craig Topper0cd25942017-09-27 22:57:18 +00004423 const APInt *CmpC;
4424 if (match(Op1, m_APInt(CmpC))) {
4425 if (*CmpC == Op0Min + 1) // A <s C -> A == C-1 if min(A)+1 == C
Sanjay Patel3151dec2016-09-12 15:24:31 +00004426 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Craig Topper0cd25942017-09-27 22:57:18 +00004427 ConstantInt::get(Op1->getType(), *CmpC - 1));
Sanjay Patel3151dec2016-09-12 15:24:31 +00004428 }
4429 break;
Craig Topper0cd25942017-09-27 22:57:18 +00004430 }
4431 case ICmpInst::ICMP_SGT: {
Sanjay Patel3151dec2016-09-12 15:24:31 +00004432 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
4433 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
4434 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
4435 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Sanjay Patel3151dec2016-09-12 15:24:31 +00004436 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
4437 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
Craig Topper0cd25942017-09-27 22:57:18 +00004438 const APInt *CmpC;
4439 if (match(Op1, m_APInt(CmpC))) {
4440 if (*CmpC == Op0Max - 1) // A >s C -> A == C+1 if max(A)-1 == C
Sanjay Patel3151dec2016-09-12 15:24:31 +00004441 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Craig Topper0cd25942017-09-27 22:57:18 +00004442 ConstantInt::get(Op1->getType(), *CmpC + 1));
Sanjay Patel3151dec2016-09-12 15:24:31 +00004443 }
4444 break;
Craig Topper0cd25942017-09-27 22:57:18 +00004445 }
Sanjay Patel3151dec2016-09-12 15:24:31 +00004446 case ICmpInst::ICMP_SGE:
4447 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
4448 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
4449 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
4450 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
4451 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Craig Topperea927ba2017-09-22 21:47:22 +00004452 if (Op1Min == Op0Max) // A >=s B -> A == B if max(A) == min(B)
4453 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
Sanjay Patel3151dec2016-09-12 15:24:31 +00004454 break;
4455 case ICmpInst::ICMP_SLE:
4456 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
4457 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
4458 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
4459 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
4460 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Craig Topperea927ba2017-09-22 21:47:22 +00004461 if (Op1Max == Op0Min) // A <=s B -> A == B if min(A) == max(B)
4462 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
Sanjay Patel3151dec2016-09-12 15:24:31 +00004463 break;
4464 case ICmpInst::ICMP_UGE:
4465 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
4466 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
4467 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
4468 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
4469 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Craig Topperea927ba2017-09-22 21:47:22 +00004470 if (Op1Min == Op0Max) // A >=u B -> A == B if max(A) == min(B)
4471 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
Sanjay Patel3151dec2016-09-12 15:24:31 +00004472 break;
4473 case ICmpInst::ICMP_ULE:
4474 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
4475 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
4476 return replaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
4477 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
4478 return replaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Craig Topperea927ba2017-09-22 21:47:22 +00004479 if (Op1Max == Op0Min) // A <=u B -> A == B if min(A) == max(B)
4480 return new ICmpInst(ICmpInst::ICMP_EQ, Op0, Op1);
Sanjay Patel3151dec2016-09-12 15:24:31 +00004481 break;
4482 }
4483
4484 // Turn a signed comparison into an unsigned one if both operands are known to
4485 // have the same sign.
4486 if (I.isSigned() &&
Craig Topperb45eabc2017-04-26 16:39:58 +00004487 ((Op0Known.Zero.isNegative() && Op1Known.Zero.isNegative()) ||
4488 (Op0Known.One.isNegative() && Op1Known.One.isNegative())))
Sanjay Patel3151dec2016-09-12 15:24:31 +00004489 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
4490
4491 return nullptr;
4492}
4493
Sanjay Pateld5b0e542016-04-29 16:22:25 +00004494/// If we have an icmp le or icmp ge instruction with a constant operand, turn
4495/// it into the appropriate icmp lt or icmp gt instruction. This transform
4496/// allows them to be folded in visitICmpInst.
Sanjay Patele9b2c322016-05-17 00:57:57 +00004497static ICmpInst *canonicalizeCmpWithConstant(ICmpInst &I) {
4498 ICmpInst::Predicate Pred = I.getPredicate();
4499 if (Pred != ICmpInst::ICMP_SLE && Pred != ICmpInst::ICMP_SGE &&
4500 Pred != ICmpInst::ICMP_ULE && Pred != ICmpInst::ICMP_UGE)
4501 return nullptr;
4502
Sanjay Pateld5b0e542016-04-29 16:22:25 +00004503 Value *Op0 = I.getOperand(0);
4504 Value *Op1 = I.getOperand(1);
Sanjay Patele9b2c322016-05-17 00:57:57 +00004505 auto *Op1C = dyn_cast<Constant>(Op1);
4506 if (!Op1C)
4507 return nullptr;
Sanjay Pateld5b0e542016-04-29 16:22:25 +00004508
Sanjay Patele9b2c322016-05-17 00:57:57 +00004509 // Check if the constant operand can be safely incremented/decremented without
4510 // overflowing/underflowing. For scalars, SimplifyICmpInst has already handled
4511 // the edge cases for us, so we just assert on them. For vectors, we must
4512 // handle the edge cases.
4513 Type *Op1Type = Op1->getType();
4514 bool IsSigned = I.isSigned();
4515 bool IsLE = (Pred == ICmpInst::ICMP_SLE || Pred == ICmpInst::ICMP_ULE);
Sanjay Patel18254932016-05-17 01:12:31 +00004516 auto *CI = dyn_cast<ConstantInt>(Op1C);
4517 if (CI) {
Sanjay Patele9b2c322016-05-17 00:57:57 +00004518 // A <= MAX -> TRUE ; A >= MIN -> TRUE
4519 assert(IsLE ? !CI->isMaxValue(IsSigned) : !CI->isMinValue(IsSigned));
4520 } else if (Op1Type->isVectorTy()) {
Sanjay Patelb79ab272016-05-13 15:10:46 +00004521 // TODO? If the edge cases for vectors were guaranteed to be handled as they
Sanjay Patele9b2c322016-05-17 00:57:57 +00004522 // are for scalar, we could remove the min/max checks. However, to do that,
4523 // we would have to use insertelement/shufflevector to replace edge values.
4524 unsigned NumElts = Op1Type->getVectorNumElements();
4525 for (unsigned i = 0; i != NumElts; ++i) {
4526 Constant *Elt = Op1C->getAggregateElement(i);
Benjamin Kramerca9a0fe2016-05-17 12:08:55 +00004527 if (!Elt)
4528 return nullptr;
4529
Sanjay Patele9b2c322016-05-17 00:57:57 +00004530 if (isa<UndefValue>(Elt))
4531 continue;
Sanjay Patel06b127a2016-09-15 14:37:50 +00004532
Sanjay Patele9b2c322016-05-17 00:57:57 +00004533 // Bail out if we can't determine if this constant is min/max or if we
4534 // know that this constant is min/max.
4535 auto *CI = dyn_cast<ConstantInt>(Elt);
4536 if (!CI || (IsLE ? CI->isMaxValue(IsSigned) : CI->isMinValue(IsSigned)))
4537 return nullptr;
Sanjay Patelb79ab272016-05-13 15:10:46 +00004538 }
Sanjay Patele9b2c322016-05-17 00:57:57 +00004539 } else {
4540 // ConstantExpr?
4541 return nullptr;
Sanjay Patelb79ab272016-05-13 15:10:46 +00004542 }
Sanjay Pateld5b0e542016-04-29 16:22:25 +00004543
Sanjay Patele9b2c322016-05-17 00:57:57 +00004544 // Increment or decrement the constant and set the new comparison predicate:
4545 // ULE -> ULT ; UGE -> UGT ; SLE -> SLT ; SGE -> SGT
Sanjay Patel22b01fe2016-05-17 20:20:40 +00004546 Constant *OneOrNegOne = ConstantInt::get(Op1Type, IsLE ? 1 : -1, true);
Sanjay Patele9b2c322016-05-17 00:57:57 +00004547 CmpInst::Predicate NewPred = IsLE ? ICmpInst::ICMP_ULT: ICmpInst::ICMP_UGT;
4548 NewPred = IsSigned ? ICmpInst::getSignedPredicate(NewPred) : NewPred;
4549 return new ICmpInst(NewPred, Op0, ConstantExpr::getAdd(Op1C, OneOrNegOne));
Sanjay Pateld5b0e542016-04-29 16:22:25 +00004550}
4551
Sanjay Patele5747e32017-05-17 22:15:07 +00004552/// Integer compare with boolean values can always be turned into bitwise ops.
4553static Instruction *canonicalizeICmpBool(ICmpInst &I,
4554 InstCombiner::BuilderTy &Builder) {
4555 Value *A = I.getOperand(0), *B = I.getOperand(1);
Craig Topperfde47232017-07-09 07:04:03 +00004556 assert(A->getType()->isIntOrIntVectorTy(1) && "Bools only");
Sanjay Patele5747e32017-05-17 22:15:07 +00004557
Sanjay Patelba212c22017-05-17 22:29:40 +00004558 // A boolean compared to true/false can be simplified to Op0/true/false in
4559 // 14 out of the 20 (10 predicates * 2 constants) possible combinations.
4560 // Cases not handled by InstSimplify are always 'not' of Op0.
4561 if (match(B, m_Zero())) {
4562 switch (I.getPredicate()) {
4563 case CmpInst::ICMP_EQ: // A == 0 -> !A
4564 case CmpInst::ICMP_ULE: // A <=u 0 -> !A
4565 case CmpInst::ICMP_SGE: // A >=s 0 -> !A
4566 return BinaryOperator::CreateNot(A);
4567 default:
4568 llvm_unreachable("ICmp i1 X, C not simplified as expected.");
4569 }
4570 } else if (match(B, m_One())) {
4571 switch (I.getPredicate()) {
4572 case CmpInst::ICMP_NE: // A != 1 -> !A
4573 case CmpInst::ICMP_ULT: // A <u 1 -> !A
4574 case CmpInst::ICMP_SGT: // A >s -1 -> !A
4575 return BinaryOperator::CreateNot(A);
4576 default:
4577 llvm_unreachable("ICmp i1 X, C not simplified as expected.");
4578 }
4579 }
4580
Sanjay Patele5747e32017-05-17 22:15:07 +00004581 switch (I.getPredicate()) {
4582 default:
4583 llvm_unreachable("Invalid icmp instruction!");
4584 case ICmpInst::ICMP_EQ:
4585 // icmp eq i1 A, B -> ~(A ^ B)
4586 return BinaryOperator::CreateNot(Builder.CreateXor(A, B));
4587
4588 case ICmpInst::ICMP_NE:
4589 // icmp ne i1 A, B -> A ^ B
4590 return BinaryOperator::CreateXor(A, B);
4591
4592 case ICmpInst::ICMP_UGT:
4593 // icmp ugt -> icmp ult
4594 std::swap(A, B);
4595 LLVM_FALLTHROUGH;
4596 case ICmpInst::ICMP_ULT:
4597 // icmp ult i1 A, B -> ~A & B
4598 return BinaryOperator::CreateAnd(Builder.CreateNot(A), B);
4599
4600 case ICmpInst::ICMP_SGT:
4601 // icmp sgt -> icmp slt
4602 std::swap(A, B);
4603 LLVM_FALLTHROUGH;
4604 case ICmpInst::ICMP_SLT:
4605 // icmp slt i1 A, B -> A & ~B
4606 return BinaryOperator::CreateAnd(Builder.CreateNot(B), A);
4607
4608 case ICmpInst::ICMP_UGE:
4609 // icmp uge -> icmp ule
4610 std::swap(A, B);
4611 LLVM_FALLTHROUGH;
4612 case ICmpInst::ICMP_ULE:
4613 // icmp ule i1 A, B -> ~A | B
4614 return BinaryOperator::CreateOr(Builder.CreateNot(A), B);
4615
4616 case ICmpInst::ICMP_SGE:
4617 // icmp sge -> icmp sle
4618 std::swap(A, B);
4619 LLVM_FALLTHROUGH;
4620 case ICmpInst::ICMP_SLE:
4621 // icmp sle i1 A, B -> A | ~B
4622 return BinaryOperator::CreateOr(Builder.CreateNot(B), A);
4623 }
4624}
4625
Roman Lebedev75404fb2018-09-12 18:19:43 +00004626// Transform pattern like:
Roman Lebedev6dc87002018-09-13 20:33:12 +00004627// (1 << Y) u<= X or ~(-1 << Y) u< X
4628// (1 << Y) u> X or ~(-1 << Y) u>= X
Roman Lebedev75404fb2018-09-12 18:19:43 +00004629// Into:
4630// (X l>> Y) != 0
4631// (X l>> Y) == 0
4632static Instruction *foldICmpWithHighBitMask(ICmpInst &Cmp,
4633 InstCombiner::BuilderTy &Builder) {
Roman Lebedev6dc87002018-09-13 20:33:12 +00004634 ICmpInst::Predicate Pred, NewPred;
Roman Lebedev75404fb2018-09-12 18:19:43 +00004635 Value *X, *Y;
Roman Lebedev6dc87002018-09-13 20:33:12 +00004636 if (match(&Cmp,
4637 m_c_ICmp(Pred, m_OneUse(m_Shl(m_One(), m_Value(Y))), m_Value(X)))) {
4638 // We want X to be the icmp's second operand, so swap predicate if it isn't.
4639 if (Cmp.getOperand(0) == X)
4640 Pred = Cmp.getSwappedPredicate();
Roman Lebedev75404fb2018-09-12 18:19:43 +00004641
Roman Lebedev6dc87002018-09-13 20:33:12 +00004642 switch (Pred) {
4643 case ICmpInst::ICMP_ULE:
4644 NewPred = ICmpInst::ICMP_NE;
4645 break;
4646 case ICmpInst::ICMP_UGT:
4647 NewPred = ICmpInst::ICMP_EQ;
4648 break;
4649 default:
4650 return nullptr;
4651 }
4652 } else if (match(&Cmp,
4653 m_c_ICmp(Pred,
4654 m_OneUse(m_Not(m_Shl(m_AllOnes(), m_Value(Y)))),
4655 m_Value(X)))) {
4656 // We want X to be the icmp's second operand, so swap predicate if it isn't.
4657 if (Cmp.getOperand(0) == X)
4658 Pred = Cmp.getSwappedPredicate();
Roman Lebedev75404fb2018-09-12 18:19:43 +00004659
Roman Lebedev6dc87002018-09-13 20:33:12 +00004660 switch (Pred) {
4661 case ICmpInst::ICMP_ULT:
4662 NewPred = ICmpInst::ICMP_NE;
4663 break;
4664 case ICmpInst::ICMP_UGE:
4665 NewPred = ICmpInst::ICMP_EQ;
4666 break;
4667 default:
4668 return nullptr;
4669 }
4670 } else
Roman Lebedev75404fb2018-09-12 18:19:43 +00004671 return nullptr;
Roman Lebedev75404fb2018-09-12 18:19:43 +00004672
4673 Value *NewX = Builder.CreateLShr(X, Y, X->getName() + ".highbits");
4674 Constant *Zero = Constant::getNullValue(NewX->getType());
4675 return CmpInst::Create(Instruction::ICmp, NewPred, NewX, Zero);
4676}
4677
Sanjay Patel039f5562018-08-16 12:52:17 +00004678static Instruction *foldVectorCmp(CmpInst &Cmp,
4679 InstCombiner::BuilderTy &Builder) {
4680 // If both arguments of the cmp are shuffles that use the same mask and
4681 // shuffle within a single vector, move the shuffle after the cmp.
4682 Value *LHS = Cmp.getOperand(0), *RHS = Cmp.getOperand(1);
4683 Value *V1, *V2;
4684 Constant *M;
4685 if (match(LHS, m_ShuffleVector(m_Value(V1), m_Undef(), m_Constant(M))) &&
4686 match(RHS, m_ShuffleVector(m_Value(V2), m_Undef(), m_Specific(M))) &&
4687 V1->getType() == V2->getType() &&
4688 (LHS->hasOneUse() || RHS->hasOneUse())) {
4689 // cmp (shuffle V1, M), (shuffle V2, M) --> shuffle (cmp V1, V2), M
4690 CmpInst::Predicate P = Cmp.getPredicate();
4691 Value *NewCmp = isa<ICmpInst>(Cmp) ? Builder.CreateICmp(P, V1, V2)
4692 : Builder.CreateFCmp(P, V1, V2);
4693 return new ShuffleVectorInst(NewCmp, UndefValue::get(NewCmp->getType()), M);
4694 }
4695 return nullptr;
4696}
4697
Chris Lattner2188e402010-01-04 07:37:31 +00004698Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
4699 bool Changed = false;
Chris Lattner9306ffa2010-02-01 19:54:45 +00004700 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Quentin Colombet5ab55552013-09-09 20:56:48 +00004701 unsigned Op0Cplxity = getComplexity(Op0);
4702 unsigned Op1Cplxity = getComplexity(Op1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00004703
Chris Lattner2188e402010-01-04 07:37:31 +00004704 /// Orders the operands of the compare so that they are listed from most
4705 /// complex to least complex. This puts constants before unary operators,
4706 /// before binary operators.
Quentin Colombet5ab55552013-09-09 20:56:48 +00004707 if (Op0Cplxity < Op1Cplxity ||
Sanjay Patel4c204232016-06-04 20:39:22 +00004708 (Op0Cplxity == Op1Cplxity && swapMayExposeCSEOpportunities(Op0, Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00004709 I.swapOperands();
Chris Lattner9306ffa2010-02-01 19:54:45 +00004710 std::swap(Op0, Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00004711 Changed = true;
4712 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004713
Daniel Berlin2c75c632017-04-26 20:56:07 +00004714 if (Value *V = SimplifyICmpInst(I.getPredicate(), Op0, Op1,
4715 SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00004716 return replaceInstUsesWith(I, V);
Jim Grosbach129c52a2011-09-30 18:09:53 +00004717
Uriel Korach18972232017-09-10 08:31:22 +00004718 // Comparing -val or val with non-zero is the same as just comparing val
Pete Cooperfdddc272011-12-01 19:13:26 +00004719 // ie, abs(val) != 0 -> val != 0
Sanjay Patel4c204232016-06-04 20:39:22 +00004720 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero())) {
Pete Cooperfdddc272011-12-01 19:13:26 +00004721 Value *Cond, *SelectTrue, *SelectFalse;
4722 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
Pete Cooperbc5c5242011-12-01 03:58:40 +00004723 m_Value(SelectFalse)))) {
Pete Cooperfdddc272011-12-01 19:13:26 +00004724 if (Value *V = dyn_castNegVal(SelectTrue)) {
4725 if (V == SelectFalse)
4726 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
4727 }
4728 else if (Value *V = dyn_castNegVal(SelectFalse)) {
4729 if (V == SelectTrue)
4730 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
Pete Cooperbc5c5242011-12-01 03:58:40 +00004731 }
4732 }
4733 }
4734
Craig Topperfde47232017-07-09 07:04:03 +00004735 if (Op0->getType()->isIntOrIntVectorTy(1))
Craig Topperbb4069e2017-07-07 23:16:26 +00004736 if (Instruction *Res = canonicalizeICmpBool(I, Builder))
Sanjay Patele5747e32017-05-17 22:15:07 +00004737 return Res;
Chris Lattner2188e402010-01-04 07:37:31 +00004738
Sanjay Patele9b2c322016-05-17 00:57:57 +00004739 if (ICmpInst *NewICmp = canonicalizeCmpWithConstant(I))
Sanjay Pateld5b0e542016-04-29 16:22:25 +00004740 return NewICmp;
4741
Sanjay Patel06b127a2016-09-15 14:37:50 +00004742 if (Instruction *Res = foldICmpWithConstant(I))
4743 return Res;
Chris Lattner2188e402010-01-04 07:37:31 +00004744
Max Kazantsev20da7e42018-07-06 04:04:13 +00004745 if (Instruction *Res = foldICmpUsingKnownBits(I))
4746 return Res;
4747
Chris Lattner2188e402010-01-04 07:37:31 +00004748 // Test if the ICmpInst instruction is used exclusively by a select as
4749 // part of a minimum or maximum operation. If so, refrain from doing
4750 // any other folding. This helps out other analyses which understand
4751 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
4752 // and CodeGen. And in this case, at least one of the comparison
4753 // operands has at least one user besides the compare (the select),
4754 // which would often largely negate the benefit of folding anyway.
Craig Topperd3e57812017-11-12 02:28:21 +00004755 //
4756 // Do the same for the other patterns recognized by matchSelectPattern.
Chris Lattner2188e402010-01-04 07:37:31 +00004757 if (I.hasOneUse())
Craig Topperd3e57812017-11-12 02:28:21 +00004758 if (SelectInst *SI = dyn_cast<SelectInst>(I.user_back())) {
4759 Value *A, *B;
4760 SelectPatternResult SPR = matchSelectPattern(SI, A, B);
4761 if (SPR.Flavor != SPF_UNKNOWN)
Craig Topperf40110f2014-04-25 05:29:35 +00004762 return nullptr;
Craig Topperd3e57812017-11-12 02:28:21 +00004763 }
Chris Lattner2188e402010-01-04 07:37:31 +00004764
Nikolai Bozhenov0e7ebbc2017-10-16 09:19:21 +00004765 // Do this after checking for min/max to prevent infinite looping.
4766 if (Instruction *Res = foldICmpWithZero(I))
4767 return Res;
4768
Sanjay Patelfebcb9c2017-01-27 23:26:27 +00004769 // FIXME: We only do this after checking for min/max to prevent infinite
4770 // looping caused by a reverse canonicalization of these patterns for min/max.
4771 // FIXME: The organization of folds is a mess. These would naturally go into
4772 // canonicalizeCmpWithConstant(), but we can't move all of the above folds
4773 // down here after the min/max restriction.
4774 ICmpInst::Predicate Pred = I.getPredicate();
4775 const APInt *C;
4776 if (match(Op1, m_APInt(C))) {
4777 // For i32: x >u 2147483647 -> x <s 0 -> true if sign bit set
4778 if (Pred == ICmpInst::ICMP_UGT && C->isMaxSignedValue()) {
4779 Constant *Zero = Constant::getNullValue(Op0->getType());
4780 return new ICmpInst(ICmpInst::ICMP_SLT, Op0, Zero);
4781 }
4782
4783 // For i32: x <u 2147483648 -> x >s -1 -> true if sign bit clear
4784 if (Pred == ICmpInst::ICMP_ULT && C->isMinSignedValue()) {
4785 Constant *AllOnes = Constant::getAllOnesValue(Op0->getType());
4786 return new ICmpInst(ICmpInst::ICMP_SGT, Op0, AllOnes);
4787 }
4788 }
4789
Sanjay Patelf58f68c2016-09-10 15:03:44 +00004790 if (Instruction *Res = foldICmpInstWithConstant(I))
Sanjay Patel1271bf92016-07-23 13:06:49 +00004791 return Res;
4792
Sanjay Patel10494b22016-09-16 16:10:22 +00004793 if (Instruction *Res = foldICmpInstWithConstantNotInt(I))
4794 return Res;
Chris Lattner2188e402010-01-04 07:37:31 +00004795
4796 // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
4797 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
Sanjay Patel43395062016-07-21 18:07:40 +00004798 if (Instruction *NI = foldGEPICmp(GEP, Op1, I.getPredicate(), I))
Chris Lattner2188e402010-01-04 07:37:31 +00004799 return NI;
4800 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
Sanjay Patel43395062016-07-21 18:07:40 +00004801 if (Instruction *NI = foldGEPICmp(GEP, Op0,
Chris Lattner2188e402010-01-04 07:37:31 +00004802 ICmpInst::getSwappedPredicate(I.getPredicate()), I))
4803 return NI;
4804
Hans Wennborgf1f36512015-10-07 00:20:07 +00004805 // Try to optimize equality comparisons against alloca-based pointers.
4806 if (Op0->getType()->isPointerTy() && I.isEquality()) {
4807 assert(Op1->getType()->isPointerTy() && "Comparing pointer with non-pointer?");
4808 if (auto *Alloca = dyn_cast<AllocaInst>(GetUnderlyingObject(Op0, DL)))
Sanjay Patel43395062016-07-21 18:07:40 +00004809 if (Instruction *New = foldAllocaCmp(I, Alloca, Op1))
Hans Wennborgf1f36512015-10-07 00:20:07 +00004810 return New;
4811 if (auto *Alloca = dyn_cast<AllocaInst>(GetUnderlyingObject(Op1, DL)))
Sanjay Patel43395062016-07-21 18:07:40 +00004812 if (Instruction *New = foldAllocaCmp(I, Alloca, Op0))
Hans Wennborgf1f36512015-10-07 00:20:07 +00004813 return New;
4814 }
4815
Sanjay Patel841aac02018-03-25 14:01:42 +00004816 // Zero-equality and sign-bit checks are preserved through sitofp + bitcast.
Roman Lebedeve6da3062018-03-18 15:53:02 +00004817 Value *X;
Sanjay Patel745a9c62018-03-24 15:45:02 +00004818 if (match(Op0, m_BitCast(m_SIToFP(m_Value(X))))) {
Sanjay Patel841aac02018-03-25 14:01:42 +00004819 // icmp eq (bitcast (sitofp X)), 0 --> icmp eq X, 0
4820 // icmp ne (bitcast (sitofp X)), 0 --> icmp ne X, 0
4821 // icmp slt (bitcast (sitofp X)), 0 --> icmp slt X, 0
4822 // icmp sgt (bitcast (sitofp X)), 0 --> icmp sgt X, 0
4823 if ((Pred == ICmpInst::ICMP_EQ || Pred == ICmpInst::ICMP_SLT ||
4824 Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT) &&
4825 match(Op1, m_Zero()))
Sanjay Patel745a9c62018-03-24 15:45:02 +00004826 return new ICmpInst(Pred, X, ConstantInt::getNullValue(X->getType()));
Sanjay Patel841aac02018-03-25 14:01:42 +00004827
4828 // icmp slt (bitcast (sitofp X)), 1 --> icmp slt X, 1
4829 if (Pred == ICmpInst::ICMP_SLT && match(Op1, m_One()))
4830 return new ICmpInst(Pred, X, ConstantInt::get(X->getType(), 1));
4831
4832 // icmp sgt (bitcast (sitofp X)), -1 --> icmp sgt X, -1
Sanjay Patel745a9c62018-03-24 15:45:02 +00004833 if (Pred == ICmpInst::ICMP_SGT && match(Op1, m_AllOnes()))
4834 return new ICmpInst(Pred, X, ConstantInt::getAllOnesValue(X->getType()));
4835 }
Roman Lebedeve6da3062018-03-18 15:53:02 +00004836
4837 // Zero-equality checks are preserved through unsigned floating-point casts:
4838 // icmp eq (bitcast (uitofp X)), 0 --> icmp eq X, 0
4839 // icmp ne (bitcast (uitofp X)), 0 --> icmp ne X, 0
4840 if (match(Op0, m_BitCast(m_UIToFP(m_Value(X)))))
4841 if (I.isEquality() && match(Op1, m_Zero()))
4842 return new ICmpInst(Pred, X, ConstantInt::getNullValue(X->getType()));
4843
Chris Lattner2188e402010-01-04 07:37:31 +00004844 // Test to see if the operands of the icmp are casted versions of other
4845 // values. If the ptr->ptr cast can be stripped off both arguments, we do so
4846 // now.
4847 if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00004848 if (Op0->getType()->isPointerTy() &&
4849 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00004850 // We keep moving the cast from the left operand over to the right
4851 // operand, where it can often be eliminated completely.
4852 Op0 = CI->getOperand(0);
4853
4854 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
4855 // so eliminate it as well.
4856 if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
4857 Op1 = CI2->getOperand(0);
4858
4859 // If Op1 is a constant, we can fold the cast into the constant.
4860 if (Op0->getType() != Op1->getType()) {
4861 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
4862 Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
4863 } else {
4864 // Otherwise, cast the RHS right before the icmp
Craig Topperbb4069e2017-07-07 23:16:26 +00004865 Op1 = Builder.CreateBitCast(Op1, Op0->getType());
Chris Lattner2188e402010-01-04 07:37:31 +00004866 }
4867 }
4868 return new ICmpInst(I.getPredicate(), Op0, Op1);
4869 }
4870 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004871
Chris Lattner2188e402010-01-04 07:37:31 +00004872 if (isa<CastInst>(Op0)) {
4873 // Handle the special case of: icmp (cast bool to X), <cst>
4874 // This comes up when you have code like
4875 // int X = A < B;
4876 // if (X) ...
4877 // For generality, we handle any zero-extension of any operand comparison
4878 // with a constant or another cast from the same type.
4879 if (isa<Constant>(Op1) || isa<CastInst>(Op1))
Sanjay Patel43395062016-07-21 18:07:40 +00004880 if (Instruction *R = foldICmpWithCastAndCast(I))
Chris Lattner2188e402010-01-04 07:37:31 +00004881 return R;
4882 }
Chris Lattner2188e402010-01-04 07:37:31 +00004883
Sanjay Patel10494b22016-09-16 16:10:22 +00004884 if (Instruction *Res = foldICmpBinOp(I))
4885 return Res;
Duncan Sandse5220012011-02-17 07:46:37 +00004886
Sanjay Pateldd46b522016-12-19 17:32:37 +00004887 if (Instruction *Res = foldICmpWithMinMax(I))
Sanjay Pateld6406412016-12-15 19:13:37 +00004888 return Res;
4889
Sanjay Patel10494b22016-09-16 16:10:22 +00004890 {
4891 Value *A, *B;
David Majnemer1a08acc2013-04-12 17:25:07 +00004892 // Transform (A & ~B) == 0 --> (A & B) != 0
4893 // and (A & ~B) != 0 --> (A & B) == 0
4894 // if A is a power of 2.
4895 if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
Chandler Carruth66b31302015-01-04 12:03:27 +00004896 match(Op1, m_Zero()) &&
Craig Topperd4039f72017-05-25 21:51:12 +00004897 isKnownToBeAPowerOfTwo(A, false, 0, &I) && I.isEquality())
Craig Topperbb4069e2017-07-07 23:16:26 +00004898 return new ICmpInst(I.getInversePredicate(), Builder.CreateAnd(A, B),
David Majnemer1a08acc2013-04-12 17:25:07 +00004899 Op1);
4900
Sanjay Patel4dc85eb2017-06-02 16:11:14 +00004901 // ~X < ~Y --> Y < X
4902 // ~X < C --> X > ~C
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00004903 if (match(Op0, m_Not(m_Value(A)))) {
4904 if (match(Op1, m_Not(m_Value(B))))
4905 return new ICmpInst(I.getPredicate(), B, A);
Sanjay Patel4dc85eb2017-06-02 16:11:14 +00004906
Sanjay Patelce241f42017-06-02 16:29:41 +00004907 const APInt *C;
4908 if (match(Op1, m_APInt(C)))
Sanjay Patel4dc85eb2017-06-02 16:11:14 +00004909 return new ICmpInst(I.getSwappedPredicate(), A,
Sanjay Patelce241f42017-06-02 16:29:41 +00004910 ConstantInt::get(Op1->getType(), ~(*C)));
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00004911 }
Chris Lattner5e0c0c72010-12-19 19:37:52 +00004912
Sanjoy Dasb6c59142015-04-10 21:07:09 +00004913 Instruction *AddI = nullptr;
4914 if (match(&I, m_UAddWithOverflow(m_Value(A), m_Value(B),
4915 m_Instruction(AddI))) &&
4916 isa<IntegerType>(A->getType())) {
4917 Value *Result;
4918 Constant *Overflow;
4919 if (OptimizeOverflowCheck(OCF_UNSIGNED_ADD, A, B, *AddI, Result,
4920 Overflow)) {
Sanjay Patel4b198802016-02-01 22:23:39 +00004921 replaceInstUsesWith(*AddI, Result);
4922 return replaceInstUsesWith(I, Overflow);
Sanjoy Dasb6c59142015-04-10 21:07:09 +00004923 }
4924 }
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004925
4926 // (zext a) * (zext b) --> llvm.umul.with.overflow.
4927 if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
Sanjay Pateld93c4c02016-09-15 18:22:25 +00004928 if (Instruction *R = processUMulZExtIdiom(I, Op0, Op1, *this))
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004929 return R;
4930 }
4931 if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
Sanjay Pateld93c4c02016-09-15 18:22:25 +00004932 if (Instruction *R = processUMulZExtIdiom(I, Op1, Op0, *this))
Serge Pavlov4bb54d52014-04-13 18:23:41 +00004933 return R;
4934 }
Chris Lattner2188e402010-01-04 07:37:31 +00004935 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00004936
Sanjay Patel10494b22016-09-16 16:10:22 +00004937 if (Instruction *Res = foldICmpEquality(I))
4938 return Res;
Jim Grosbach129c52a2011-09-30 18:09:53 +00004939
David Majnemerc1eca5a2014-11-06 23:23:30 +00004940 // The 'cmpxchg' instruction returns an aggregate containing the old value and
4941 // an i1 which indicates whether or not we successfully did the swap.
4942 //
4943 // Replace comparisons between the old value and the expected value with the
4944 // indicator that 'cmpxchg' returns.
4945 //
4946 // N.B. This transform is only valid when the 'cmpxchg' is not permitted to
4947 // spuriously fail. In those cases, the old value may equal the expected
4948 // value but it is possible for the swap to not occur.
4949 if (I.getPredicate() == ICmpInst::ICMP_EQ)
4950 if (auto *EVI = dyn_cast<ExtractValueInst>(Op0))
4951 if (auto *ACXI = dyn_cast<AtomicCmpXchgInst>(EVI->getAggregateOperand()))
4952 if (EVI->getIndices()[0] == 0 && ACXI->getCompareOperand() == Op1 &&
4953 !ACXI->isWeak())
4954 return ExtractValueInst::Create(ACXI, 1);
4955
Chris Lattner2188e402010-01-04 07:37:31 +00004956 {
Craig Topperbee74792018-08-20 23:04:25 +00004957 Value *X;
4958 const APInt *C;
Chris Lattner2188e402010-01-04 07:37:31 +00004959 // icmp X+Cst, X
Craig Topperbee74792018-08-20 23:04:25 +00004960 if (match(Op0, m_Add(m_Value(X), m_APInt(C))) && Op1 == X)
4961 return foldICmpAddOpConst(X, *C, I.getPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00004962
4963 // icmp X, X+Cst
Craig Topperbee74792018-08-20 23:04:25 +00004964 if (match(Op1, m_Add(m_Value(X), m_APInt(C))) && Op0 == X)
4965 return foldICmpAddOpConst(X, *C, I.getSwappedPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00004966 }
Roman Lebedev68d54cf2018-07-11 19:05:04 +00004967
Roman Lebedev75404fb2018-09-12 18:19:43 +00004968 if (Instruction *Res = foldICmpWithHighBitMask(I, Builder))
4969 return Res;
4970
Sanjay Patel039f5562018-08-16 12:52:17 +00004971 if (I.getType()->isVectorTy())
4972 if (Instruction *Res = foldVectorCmp(I, Builder))
4973 return Res;
4974
Craig Topperf40110f2014-04-25 05:29:35 +00004975 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00004976}
4977
Sanjay Patel5f0217f2016-06-05 16:46:18 +00004978/// Fold fcmp ([us]itofp x, cst) if possible.
Sanjay Patel43395062016-07-21 18:07:40 +00004979Instruction *InstCombiner::foldFCmpIntToFPConst(FCmpInst &I, Instruction *LHSI,
Chris Lattner2188e402010-01-04 07:37:31 +00004980 Constant *RHSC) {
Craig Topperf40110f2014-04-25 05:29:35 +00004981 if (!isa<ConstantFP>(RHSC)) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00004982 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
Jim Grosbach129c52a2011-09-30 18:09:53 +00004983
Chris Lattner2188e402010-01-04 07:37:31 +00004984 // Get the width of the mantissa. We don't want to hack on conversions that
4985 // might lose information from the integer, e.g. "i64 -> float"
4986 int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
Craig Topperf40110f2014-04-25 05:29:35 +00004987 if (MantissaWidth == -1) return nullptr; // Unknown.
Jim Grosbach129c52a2011-09-30 18:09:53 +00004988
Matt Arsenault55e73122015-01-06 15:50:59 +00004989 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
4990
Chris Lattner2188e402010-01-04 07:37:31 +00004991 bool LHSUnsigned = isa<UIToFPInst>(LHSI);
Jim Grosbach129c52a2011-09-30 18:09:53 +00004992
Matt Arsenault55e73122015-01-06 15:50:59 +00004993 if (I.isEquality()) {
4994 FCmpInst::Predicate P = I.getPredicate();
4995 bool IsExact = false;
4996 APSInt RHSCvt(IntTy->getBitWidth(), LHSUnsigned);
4997 RHS.convertToInteger(RHSCvt, APFloat::rmNearestTiesToEven, &IsExact);
4998
4999 // If the floating point constant isn't an integer value, we know if we will
5000 // ever compare equal / not equal to it.
5001 if (!IsExact) {
5002 // TODO: Can never be -0.0 and other non-representable values
5003 APFloat RHSRoundInt(RHS);
5004 RHSRoundInt.roundToIntegral(APFloat::rmNearestTiesToEven);
5005 if (RHS.compare(RHSRoundInt) != APFloat::cmpEqual) {
5006 if (P == FCmpInst::FCMP_OEQ || P == FCmpInst::FCMP_UEQ)
Craig Topperbb4069e2017-07-07 23:16:26 +00005007 return replaceInstUsesWith(I, Builder.getFalse());
Matt Arsenault55e73122015-01-06 15:50:59 +00005008
5009 assert(P == FCmpInst::FCMP_ONE || P == FCmpInst::FCMP_UNE);
Craig Topperbb4069e2017-07-07 23:16:26 +00005010 return replaceInstUsesWith(I, Builder.getTrue());
Matt Arsenault55e73122015-01-06 15:50:59 +00005011 }
5012 }
5013
5014 // TODO: If the constant is exactly representable, is it always OK to do
5015 // equality compares as integer?
5016 }
5017
Arch D. Robison8ed08542015-09-15 17:51:59 +00005018 // Check to see that the input is converted from an integer type that is small
5019 // enough that preserves all bits. TODO: check here for "known" sign bits.
5020 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
5021 unsigned InputSize = IntTy->getScalarSizeInBits();
Matt Arsenault55e73122015-01-06 15:50:59 +00005022
Justin Bognerc7e4fbe2016-08-05 01:09:48 +00005023 // Following test does NOT adjust InputSize downwards for signed inputs,
5024 // because the most negative value still requires all the mantissa bits
Arch D. Robison8ed08542015-09-15 17:51:59 +00005025 // to distinguish it from one less than that value.
5026 if ((int)InputSize > MantissaWidth) {
5027 // Conversion would lose accuracy. Check if loss can impact comparison.
5028 int Exp = ilogb(RHS);
5029 if (Exp == APFloat::IEK_Inf) {
5030 int MaxExponent = ilogb(APFloat::getLargest(RHS.getSemantics()));
Justin Bognerc7e4fbe2016-08-05 01:09:48 +00005031 if (MaxExponent < (int)InputSize - !LHSUnsigned)
Arch D. Robison8ed08542015-09-15 17:51:59 +00005032 // Conversion could create infinity.
5033 return nullptr;
5034 } else {
Justin Bognerc7e4fbe2016-08-05 01:09:48 +00005035 // Note that if RHS is zero or NaN, then Exp is negative
Arch D. Robison8ed08542015-09-15 17:51:59 +00005036 // and first condition is trivially false.
Justin Bognerc7e4fbe2016-08-05 01:09:48 +00005037 if (MantissaWidth <= Exp && Exp <= (int)InputSize - !LHSUnsigned)
Arch D. Robison8ed08542015-09-15 17:51:59 +00005038 // Conversion could affect comparison.
5039 return nullptr;
5040 }
5041 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00005042
Chris Lattner2188e402010-01-04 07:37:31 +00005043 // Otherwise, we can potentially simplify the comparison. We know that it
5044 // will always come through as an integer value and we know the constant is
5045 // not a NAN (it would have been previously simplified).
5046 assert(!RHS.isNaN() && "NaN comparison not already folded!");
Jim Grosbach129c52a2011-09-30 18:09:53 +00005047
Chris Lattner2188e402010-01-04 07:37:31 +00005048 ICmpInst::Predicate Pred;
5049 switch (I.getPredicate()) {
5050 default: llvm_unreachable("Unexpected predicate!");
5051 case FCmpInst::FCMP_UEQ:
5052 case FCmpInst::FCMP_OEQ:
5053 Pred = ICmpInst::ICMP_EQ;
5054 break;
5055 case FCmpInst::FCMP_UGT:
5056 case FCmpInst::FCMP_OGT:
5057 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
5058 break;
5059 case FCmpInst::FCMP_UGE:
5060 case FCmpInst::FCMP_OGE:
5061 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
5062 break;
5063 case FCmpInst::FCMP_ULT:
5064 case FCmpInst::FCMP_OLT:
5065 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
5066 break;
5067 case FCmpInst::FCMP_ULE:
5068 case FCmpInst::FCMP_OLE:
5069 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
5070 break;
5071 case FCmpInst::FCMP_UNE:
5072 case FCmpInst::FCMP_ONE:
5073 Pred = ICmpInst::ICMP_NE;
5074 break;
5075 case FCmpInst::FCMP_ORD:
Craig Topperbb4069e2017-07-07 23:16:26 +00005076 return replaceInstUsesWith(I, Builder.getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00005077 case FCmpInst::FCMP_UNO:
Craig Topperbb4069e2017-07-07 23:16:26 +00005078 return replaceInstUsesWith(I, Builder.getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00005079 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00005080
Chris Lattner2188e402010-01-04 07:37:31 +00005081 // Now we know that the APFloat is a normal number, zero or inf.
Jim Grosbach129c52a2011-09-30 18:09:53 +00005082
Chris Lattner2188e402010-01-04 07:37:31 +00005083 // See if the FP constant is too large for the integer. For example,
5084 // comparing an i8 to 300.0.
5085 unsigned IntWidth = IntTy->getScalarSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00005086
Chris Lattner2188e402010-01-04 07:37:31 +00005087 if (!LHSUnsigned) {
5088 // If the RHS value is > SignedMax, fold the comparison. This handles +INF
5089 // and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00005090 APFloat SMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00005091 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
5092 APFloat::rmNearestTiesToEven);
5093 if (SMax.compare(RHS) == APFloat::cmpLessThan) { // smax < 13123.0
5094 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT ||
5095 Pred == ICmpInst::ICMP_SLE)
Craig Topperbb4069e2017-07-07 23:16:26 +00005096 return replaceInstUsesWith(I, Builder.getTrue());
5097 return replaceInstUsesWith(I, Builder.getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00005098 }
5099 } else {
5100 // If the RHS value is > UnsignedMax, fold the comparison. This handles
5101 // +INF and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00005102 APFloat UMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00005103 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
5104 APFloat::rmNearestTiesToEven);
5105 if (UMax.compare(RHS) == APFloat::cmpLessThan) { // umax < 13123.0
5106 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT ||
5107 Pred == ICmpInst::ICMP_ULE)
Craig Topperbb4069e2017-07-07 23:16:26 +00005108 return replaceInstUsesWith(I, Builder.getTrue());
5109 return replaceInstUsesWith(I, Builder.getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00005110 }
5111 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00005112
Chris Lattner2188e402010-01-04 07:37:31 +00005113 if (!LHSUnsigned) {
5114 // See if the RHS value is < SignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00005115 APFloat SMin(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00005116 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
5117 APFloat::rmNearestTiesToEven);
5118 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
5119 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
5120 Pred == ICmpInst::ICMP_SGE)
Craig Topperbb4069e2017-07-07 23:16:26 +00005121 return replaceInstUsesWith(I, Builder.getTrue());
5122 return replaceInstUsesWith(I, Builder.getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00005123 }
Devang Patel698452b2012-02-13 23:05:18 +00005124 } else {
5125 // See if the RHS value is < UnsignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00005126 APFloat SMin(RHS.getSemantics());
Devang Patel698452b2012-02-13 23:05:18 +00005127 SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
5128 APFloat::rmNearestTiesToEven);
5129 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
5130 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
5131 Pred == ICmpInst::ICMP_UGE)
Craig Topperbb4069e2017-07-07 23:16:26 +00005132 return replaceInstUsesWith(I, Builder.getTrue());
5133 return replaceInstUsesWith(I, Builder.getFalse());
Devang Patel698452b2012-02-13 23:05:18 +00005134 }
Chris Lattner2188e402010-01-04 07:37:31 +00005135 }
5136
5137 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
5138 // [0, UMAX], but it may still be fractional. See if it is fractional by
5139 // casting the FP value to the integer value and back, checking for equality.
5140 // Don't do this for zero, because -0.0 is not fractional.
5141 Constant *RHSInt = LHSUnsigned
5142 ? ConstantExpr::getFPToUI(RHSC, IntTy)
5143 : ConstantExpr::getFPToSI(RHSC, IntTy);
5144 if (!RHS.isZero()) {
5145 bool Equal = LHSUnsigned
5146 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
5147 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
5148 if (!Equal) {
5149 // If we had a comparison against a fractional value, we have to adjust
5150 // the compare predicate and sometimes the value. RHSC is rounded towards
5151 // zero at this point.
5152 switch (Pred) {
5153 default: llvm_unreachable("Unexpected integer comparison!");
5154 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true
Craig Topperbb4069e2017-07-07 23:16:26 +00005155 return replaceInstUsesWith(I, Builder.getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00005156 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false
Craig Topperbb4069e2017-07-07 23:16:26 +00005157 return replaceInstUsesWith(I, Builder.getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00005158 case ICmpInst::ICMP_ULE:
5159 // (float)int <= 4.4 --> int <= 4
5160 // (float)int <= -4.4 --> false
5161 if (RHS.isNegative())
Craig Topperbb4069e2017-07-07 23:16:26 +00005162 return replaceInstUsesWith(I, Builder.getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00005163 break;
5164 case ICmpInst::ICMP_SLE:
5165 // (float)int <= 4.4 --> int <= 4
5166 // (float)int <= -4.4 --> int < -4
5167 if (RHS.isNegative())
5168 Pred = ICmpInst::ICMP_SLT;
5169 break;
5170 case ICmpInst::ICMP_ULT:
5171 // (float)int < -4.4 --> false
5172 // (float)int < 4.4 --> int <= 4
5173 if (RHS.isNegative())
Craig Topperbb4069e2017-07-07 23:16:26 +00005174 return replaceInstUsesWith(I, Builder.getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00005175 Pred = ICmpInst::ICMP_ULE;
5176 break;
5177 case ICmpInst::ICMP_SLT:
5178 // (float)int < -4.4 --> int < -4
5179 // (float)int < 4.4 --> int <= 4
5180 if (!RHS.isNegative())
5181 Pred = ICmpInst::ICMP_SLE;
5182 break;
5183 case ICmpInst::ICMP_UGT:
5184 // (float)int > 4.4 --> int > 4
5185 // (float)int > -4.4 --> true
5186 if (RHS.isNegative())
Craig Topperbb4069e2017-07-07 23:16:26 +00005187 return replaceInstUsesWith(I, Builder.getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00005188 break;
5189 case ICmpInst::ICMP_SGT:
5190 // (float)int > 4.4 --> int > 4
5191 // (float)int > -4.4 --> int >= -4
5192 if (RHS.isNegative())
5193 Pred = ICmpInst::ICMP_SGE;
5194 break;
5195 case ICmpInst::ICMP_UGE:
5196 // (float)int >= -4.4 --> true
5197 // (float)int >= 4.4 --> int > 4
Bob Wilson61f3ad52012-08-07 22:35:16 +00005198 if (RHS.isNegative())
Craig Topperbb4069e2017-07-07 23:16:26 +00005199 return replaceInstUsesWith(I, Builder.getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00005200 Pred = ICmpInst::ICMP_UGT;
5201 break;
5202 case ICmpInst::ICMP_SGE:
5203 // (float)int >= -4.4 --> int >= -4
5204 // (float)int >= 4.4 --> int > 4
5205 if (!RHS.isNegative())
5206 Pred = ICmpInst::ICMP_SGT;
5207 break;
5208 }
5209 }
5210 }
5211
5212 // Lower this FP comparison into an appropriate integer version of the
5213 // comparison.
5214 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
5215}
5216
5217Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
5218 bool Changed = false;
Jim Grosbach129c52a2011-09-30 18:09:53 +00005219
Chris Lattner2188e402010-01-04 07:37:31 +00005220 /// Orders the operands of the compare so that they are listed from most
5221 /// complex to least complex. This puts constants before unary operators,
5222 /// before binary operators.
5223 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
5224 I.swapOperands();
5225 Changed = true;
5226 }
5227
Sanjay Patel6b139462017-09-02 15:11:55 +00005228 const CmpInst::Predicate Pred = I.getPredicate();
Chris Lattner2188e402010-01-04 07:37:31 +00005229 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Sanjay Patel6b139462017-09-02 15:11:55 +00005230 if (Value *V = SimplifyFCmpInst(Pred, Op0, Op1, I.getFastMathFlags(),
5231 SQ.getWithInstruction(&I)))
Sanjay Patel4b198802016-02-01 22:23:39 +00005232 return replaceInstUsesWith(I, V);
Chris Lattner2188e402010-01-04 07:37:31 +00005233
5234 // Simplify 'fcmp pred X, X'
5235 if (Op0 == Op1) {
Sanjay Patel6b139462017-09-02 15:11:55 +00005236 switch (Pred) {
5237 default: break;
Chris Lattner2188e402010-01-04 07:37:31 +00005238 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y)
5239 case FCmpInst::FCMP_ULT: // True if unordered or less than
5240 case FCmpInst::FCMP_UGT: // True if unordered or greater than
5241 case FCmpInst::FCMP_UNE: // True if unordered or not equal
5242 // Canonicalize these to be 'fcmp uno %X, 0.0'.
5243 I.setPredicate(FCmpInst::FCMP_UNO);
5244 I.setOperand(1, Constant::getNullValue(Op0->getType()));
5245 return &I;
Jim Grosbach129c52a2011-09-30 18:09:53 +00005246
Chris Lattner2188e402010-01-04 07:37:31 +00005247 case FCmpInst::FCMP_ORD: // True if ordered (no nans)
5248 case FCmpInst::FCMP_OEQ: // True if ordered and equal
5249 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal
5250 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal
5251 // Canonicalize these to be 'fcmp ord %X, 0.0'.
5252 I.setPredicate(FCmpInst::FCMP_ORD);
5253 I.setOperand(1, Constant::getNullValue(Op0->getType()));
5254 return &I;
5255 }
5256 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00005257
Sanjay Patel6840c5f2017-09-05 23:13:13 +00005258 // If we're just checking for a NaN (ORD/UNO) and have a non-NaN operand,
5259 // then canonicalize the operand to 0.0.
5260 if (Pred == CmpInst::FCMP_ORD || Pred == CmpInst::FCMP_UNO) {
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00005261 if (!match(Op0, m_PosZeroFP()) && isKnownNeverNaN(Op0, &TLI)) {
Sanjay Patel6840c5f2017-09-05 23:13:13 +00005262 I.setOperand(0, ConstantFP::getNullValue(Op0->getType()));
5263 return &I;
5264 }
Matt Arsenaultd54b7f02018-08-09 22:40:08 +00005265 if (!match(Op1, m_PosZeroFP()) && isKnownNeverNaN(Op1, &TLI)) {
Sanjay Patel6840c5f2017-09-05 23:13:13 +00005266 I.setOperand(1, ConstantFP::getNullValue(Op0->getType()));
5267 return &I;
5268 }
5269 }
5270
James Molloy2b21a7c2015-05-20 18:41:25 +00005271 // Test if the FCmpInst instruction is used exclusively by a select as
5272 // part of a minimum or maximum operation. If so, refrain from doing
5273 // any other folding. This helps out other analyses which understand
5274 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
5275 // and CodeGen. And in this case, at least one of the comparison
5276 // operands has at least one user besides the compare (the select),
5277 // which would often largely negate the benefit of folding anyway.
5278 if (I.hasOneUse())
Craig Topperd3e57812017-11-12 02:28:21 +00005279 if (SelectInst *SI = dyn_cast<SelectInst>(I.user_back())) {
5280 Value *A, *B;
5281 SelectPatternResult SPR = matchSelectPattern(SI, A, B);
5282 if (SPR.Flavor != SPF_UNKNOWN)
James Molloy2b21a7c2015-05-20 18:41:25 +00005283 return nullptr;
Craig Topperd3e57812017-11-12 02:28:21 +00005284 }
James Molloy2b21a7c2015-05-20 18:41:25 +00005285
Chris Lattner2188e402010-01-04 07:37:31 +00005286 // Handle fcmp with constant RHS
5287 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
5288 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
5289 switch (LHSI->getOpcode()) {
Benjamin Kramercbb18e92011-03-31 10:12:07 +00005290 case Instruction::FPExt: {
5291 // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
5292 FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
5293 ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
5294 if (!RHSF)
5295 break;
5296
5297 const fltSemantics *Sem;
5298 // FIXME: This shouldn't be here.
Dan Gohman518cda42011-12-17 00:04:22 +00005299 if (LHSExt->getSrcTy()->isHalfTy())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00005300 Sem = &APFloat::IEEEhalf();
Dan Gohman518cda42011-12-17 00:04:22 +00005301 else if (LHSExt->getSrcTy()->isFloatTy())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00005302 Sem = &APFloat::IEEEsingle();
Benjamin Kramercbb18e92011-03-31 10:12:07 +00005303 else if (LHSExt->getSrcTy()->isDoubleTy())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00005304 Sem = &APFloat::IEEEdouble();
Benjamin Kramercbb18e92011-03-31 10:12:07 +00005305 else if (LHSExt->getSrcTy()->isFP128Ty())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00005306 Sem = &APFloat::IEEEquad();
Benjamin Kramercbb18e92011-03-31 10:12:07 +00005307 else if (LHSExt->getSrcTy()->isX86_FP80Ty())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00005308 Sem = &APFloat::x87DoubleExtended();
Ulrich Weigand6a9bb512012-10-30 12:33:18 +00005309 else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
Stephan Bergmann17c7f702016-12-14 11:57:17 +00005310 Sem = &APFloat::PPCDoubleDouble();
Benjamin Kramercbb18e92011-03-31 10:12:07 +00005311 else
5312 break;
5313
5314 bool Lossy;
5315 APFloat F = RHSF->getValueAPF();
5316 F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
5317
Jim Grosbach24ff8342011-09-30 18:45:50 +00005318 // Avoid lossy conversions and denormals. Zero is a special case
5319 // that's OK to convert.
Jim Grosbach011dafb2011-09-30 19:58:46 +00005320 APFloat Fabs = F;
5321 Fabs.clearSign();
Benjamin Kramercbb18e92011-03-31 10:12:07 +00005322 if (!Lossy &&
Jim Grosbach011dafb2011-09-30 19:58:46 +00005323 ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
5324 APFloat::cmpLessThan) || Fabs.isZero()))
Jim Grosbach24ff8342011-09-30 18:45:50 +00005325
Sanjay Patel6b139462017-09-02 15:11:55 +00005326 return new FCmpInst(Pred, LHSExt->getOperand(0),
Benjamin Kramercbb18e92011-03-31 10:12:07 +00005327 ConstantFP::get(RHSC->getContext(), F));
5328 break;
5329 }
Chris Lattner2188e402010-01-04 07:37:31 +00005330 case Instruction::PHI:
5331 // Only fold fcmp into the PHI if the phi and fcmp are in the same
5332 // block. If in the same block, we're encouraging jump threading. If
5333 // not, we are just pessimizing the code by making an i1 phi.
5334 if (LHSI->getParent() == I.getParent())
Craig Topperfb71b7d2017-04-14 19:20:12 +00005335 if (Instruction *NV = foldOpIntoPhi(I, cast<PHINode>(LHSI)))
Chris Lattner2188e402010-01-04 07:37:31 +00005336 return NV;
5337 break;
5338 case Instruction::SIToFP:
5339 case Instruction::UIToFP:
Sanjay Patel43395062016-07-21 18:07:40 +00005340 if (Instruction *NV = foldFCmpIntToFPConst(I, LHSI, RHSC))
Chris Lattner2188e402010-01-04 07:37:31 +00005341 return NV;
5342 break;
Benjamin Kramera8c5d082011-03-31 10:12:15 +00005343 case Instruction::FSub: {
5344 // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
5345 Value *Op;
5346 if (match(LHSI, m_FNeg(m_Value(Op))))
5347 return new FCmpInst(I.getSwappedPredicate(), Op,
5348 ConstantExpr::getFNeg(RHSC));
5349 break;
5350 }
Dan Gohman94732022010-02-24 06:46:09 +00005351 case Instruction::Load:
5352 if (GetElementPtrInst *GEP =
5353 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
5354 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
5355 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
5356 !cast<LoadInst>(LHSI)->isVolatile())
Sanjay Patel43395062016-07-21 18:07:40 +00005357 if (Instruction *Res = foldCmpLoadFromIndexedGlobal(GEP, GV, I))
Dan Gohman94732022010-02-24 06:46:09 +00005358 return Res;
5359 }
5360 break;
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00005361 case Instruction::Call: {
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00005362 if (!RHSC->isNullValue())
5363 break;
5364
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00005365 CallInst *CI = cast<CallInst>(LHSI);
Justin Bogner99798402016-08-05 01:06:44 +00005366 Intrinsic::ID IID = getIntrinsicForCallSite(CI, &TLI);
David Majnemer2e02ba72016-04-15 17:21:03 +00005367 if (IID != Intrinsic::fabs)
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00005368 break;
5369
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00005370 // Various optimization for fabs compared with zero.
Sanjay Patel6b139462017-09-02 15:11:55 +00005371 switch (Pred) {
David Majnemer2e02ba72016-04-15 17:21:03 +00005372 default:
5373 break;
5374 // fabs(x) < 0 --> false
5375 case FCmpInst::FCMP_OLT:
5376 llvm_unreachable("handled by SimplifyFCmpInst");
5377 // fabs(x) > 0 --> x != 0
5378 case FCmpInst::FCMP_OGT:
5379 return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0), RHSC);
5380 // fabs(x) <= 0 --> x == 0
5381 case FCmpInst::FCMP_OLE:
5382 return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0), RHSC);
5383 // fabs(x) >= 0 --> !isnan(x)
5384 case FCmpInst::FCMP_OGE:
5385 return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0), RHSC);
5386 // fabs(x) == 0 --> x == 0
5387 // fabs(x) != 0 --> x != 0
5388 case FCmpInst::FCMP_OEQ:
5389 case FCmpInst::FCMP_UEQ:
5390 case FCmpInst::FCMP_ONE:
5391 case FCmpInst::FCMP_UNE:
Sanjay Patel6b139462017-09-02 15:11:55 +00005392 return new FCmpInst(Pred, CI->getArgOperand(0), RHSC);
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00005393 }
5394 }
Chris Lattner2188e402010-01-04 07:37:31 +00005395 }
Chris Lattner2188e402010-01-04 07:37:31 +00005396 }
5397
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00005398 // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
Benjamin Kramerd159d942011-03-31 10:12:22 +00005399 Value *X, *Y;
5400 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00005401 return new FCmpInst(I.getSwappedPredicate(), X, Y);
Benjamin Kramerd159d942011-03-31 10:12:22 +00005402
Benjamin Kramer2ccfbc82011-03-31 10:11:58 +00005403 // fcmp (fpext x), (fpext y) -> fcmp x, y
5404 if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
5405 if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
5406 if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
Sanjay Patel6b139462017-09-02 15:11:55 +00005407 return new FCmpInst(Pred, LHSExt->getOperand(0), RHSExt->getOperand(0));
Benjamin Kramer2ccfbc82011-03-31 10:11:58 +00005408
Sanjay Patel039f5562018-08-16 12:52:17 +00005409 if (I.getType()->isVectorTy())
5410 if (Instruction *Res = foldVectorCmp(I, Builder))
5411 return Res;
5412
Craig Topperf40110f2014-04-25 05:29:35 +00005413 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00005414}