blob: 6e4336ef87543fb88d53f49ae3342748d30e73cd [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"
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000016#include "llvm/ADT/Statistic.h"
Eli Friedman911e12f2011-07-20 21:57:23 +000017#include "llvm/Analysis/ConstantFolding.h"
Chris Lattner2188e402010-01-04 07:37:31 +000018#include "llvm/Analysis/InstructionSimplify.h"
19#include "llvm/Analysis/MemoryBuiltins.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000020#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000021#include "llvm/IR/DataLayout.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000022#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000023#include "llvm/IR/IntrinsicInst.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000024#include "llvm/IR/PatternMatch.h"
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +000025#include "llvm/Support/CommandLine.h"
26#include "llvm/Support/Debug.h"
Chandler Carruth62d42152015-01-15 02:16:27 +000027#include "llvm/Analysis/TargetLibraryInfo.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
37// Initialization Routines
38
Chris Lattner98457102011-02-10 05:23:05 +000039static ConstantInt *getOne(Constant *C) {
40 return ConstantInt::get(cast<IntegerType>(C->getType()), 1);
41}
42
Chris Lattner2188e402010-01-04 07:37:31 +000043static ConstantInt *ExtractElement(Constant *V, Constant *Idx) {
44 return cast<ConstantInt>(ConstantExpr::getExtractElement(V, Idx));
45}
46
47static bool HasAddOverflow(ConstantInt *Result,
48 ConstantInt *In1, ConstantInt *In2,
49 bool IsSigned) {
Chris Lattnerb1a15122011-07-15 06:08:15 +000050 if (!IsSigned)
Chris Lattner2188e402010-01-04 07:37:31 +000051 return Result->getValue().ult(In1->getValue());
Chris Lattnerb1a15122011-07-15 06:08:15 +000052
53 if (In2->isNegative())
54 return Result->getValue().sgt(In1->getValue());
55 return Result->getValue().slt(In1->getValue());
Chris Lattner2188e402010-01-04 07:37:31 +000056}
57
58/// AddWithOverflow - Compute Result = In1+In2, returning true if the result
59/// overflowed for this type.
60static bool AddWithOverflow(Constant *&Result, Constant *In1,
61 Constant *In2, bool IsSigned = false) {
62 Result = ConstantExpr::getAdd(In1, In2);
63
Chris Lattner229907c2011-07-18 04:54:35 +000064 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
Chris Lattner2188e402010-01-04 07:37:31 +000065 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
66 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
67 if (HasAddOverflow(ExtractElement(Result, Idx),
68 ExtractElement(In1, Idx),
69 ExtractElement(In2, Idx),
70 IsSigned))
71 return true;
72 }
73 return false;
74 }
75
76 return HasAddOverflow(cast<ConstantInt>(Result),
77 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
78 IsSigned);
79}
80
81static bool HasSubOverflow(ConstantInt *Result,
82 ConstantInt *In1, ConstantInt *In2,
83 bool IsSigned) {
Chris Lattnerb1a15122011-07-15 06:08:15 +000084 if (!IsSigned)
Chris Lattner2188e402010-01-04 07:37:31 +000085 return Result->getValue().ugt(In1->getValue());
Jim Grosbach129c52a2011-09-30 18:09:53 +000086
Chris Lattnerb1a15122011-07-15 06:08:15 +000087 if (In2->isNegative())
88 return Result->getValue().slt(In1->getValue());
89
90 return Result->getValue().sgt(In1->getValue());
Chris Lattner2188e402010-01-04 07:37:31 +000091}
92
93/// SubWithOverflow - Compute Result = In1-In2, returning true if the result
94/// overflowed for this type.
95static bool SubWithOverflow(Constant *&Result, Constant *In1,
96 Constant *In2, bool IsSigned = false) {
97 Result = ConstantExpr::getSub(In1, In2);
98
Chris Lattner229907c2011-07-18 04:54:35 +000099 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
Chris Lattner2188e402010-01-04 07:37:31 +0000100 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
101 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
102 if (HasSubOverflow(ExtractElement(Result, Idx),
103 ExtractElement(In1, Idx),
104 ExtractElement(In2, Idx),
105 IsSigned))
106 return true;
107 }
108 return false;
109 }
110
111 return HasSubOverflow(cast<ConstantInt>(Result),
112 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
113 IsSigned);
114}
115
116/// isSignBitCheck - Given an exploded icmp instruction, return true if the
117/// comparison only checks the sign bit. If it only checks the sign bit, set
118/// TrueIfSigned if the result of the comparison is true when the input value is
119/// signed.
120static bool isSignBitCheck(ICmpInst::Predicate pred, ConstantInt *RHS,
121 bool &TrueIfSigned) {
122 switch (pred) {
123 case ICmpInst::ICMP_SLT: // True if LHS s< 0
124 TrueIfSigned = true;
125 return RHS->isZero();
126 case ICmpInst::ICMP_SLE: // True if LHS s<= RHS and RHS == -1
127 TrueIfSigned = true;
128 return RHS->isAllOnesValue();
129 case ICmpInst::ICMP_SGT: // True if LHS s> -1
130 TrueIfSigned = false;
131 return RHS->isAllOnesValue();
132 case ICmpInst::ICMP_UGT:
133 // True if LHS u> RHS and RHS == high-bit-mask - 1
134 TrueIfSigned = true;
Chris Lattnerb1a15122011-07-15 06:08:15 +0000135 return RHS->isMaxValue(true);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000136 case ICmpInst::ICMP_UGE:
Chris Lattner2188e402010-01-04 07:37:31 +0000137 // True if LHS u>= RHS and RHS == high-bit-mask (2^7, 2^15, 2^31, etc)
138 TrueIfSigned = true;
139 return RHS->getValue().isSignBit();
140 default:
141 return false;
142 }
143}
144
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000145/// Returns true if the exploded icmp can be expressed as a signed comparison
146/// to zero and updates the predicate accordingly.
147/// The signedness of the comparison is preserved.
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000148static bool isSignTest(ICmpInst::Predicate &pred, const ConstantInt *RHS) {
149 if (!ICmpInst::isSigned(pred))
150 return false;
151
152 if (RHS->isZero())
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000153 return ICmpInst::isRelational(pred);
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000154
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000155 if (RHS->isOne()) {
156 if (pred == ICmpInst::ICMP_SLT) {
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000157 pred = ICmpInst::ICMP_SLE;
158 return true;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000159 }
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000160 } else if (RHS->isAllOnesValue()) {
161 if (pred == ICmpInst::ICMP_SGT) {
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000162 pred = ICmpInst::ICMP_SGE;
163 return true;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000164 }
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000165 }
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000166
167 return false;
168}
169
Chris Lattner2188e402010-01-04 07:37:31 +0000170// isHighOnes - Return true if the constant is of the form 1+0+.
171// This is the same as lowones(~X).
172static bool isHighOnes(const ConstantInt *CI) {
173 return (~CI->getValue() + 1).isPowerOf2();
174}
175
Jim Grosbach129c52a2011-09-30 18:09:53 +0000176/// ComputeSignedMinMaxValuesFromKnownBits - Given a signed integer type and a
Chris Lattner2188e402010-01-04 07:37:31 +0000177/// set of known zero and one bits, compute the maximum and minimum values that
178/// could have the specified known zero and known one bits, returning them in
179/// min/max.
180static void ComputeSignedMinMaxValuesFromKnownBits(const APInt& KnownZero,
181 const APInt& KnownOne,
182 APInt& Min, APInt& Max) {
183 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
184 KnownZero.getBitWidth() == Min.getBitWidth() &&
185 KnownZero.getBitWidth() == Max.getBitWidth() &&
186 "KnownZero, KnownOne and Min, Max must have equal bitwidth.");
187 APInt UnknownBits = ~(KnownZero|KnownOne);
188
189 // The minimum value is when all unknown bits are zeros, EXCEPT for the sign
190 // bit if it is unknown.
191 Min = KnownOne;
192 Max = KnownOne|UnknownBits;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000193
Chris Lattner2188e402010-01-04 07:37:31 +0000194 if (UnknownBits.isNegative()) { // Sign bit is unknown
Jay Foad25a5e4c2010-12-01 08:53:58 +0000195 Min.setBit(Min.getBitWidth()-1);
196 Max.clearBit(Max.getBitWidth()-1);
Chris Lattner2188e402010-01-04 07:37:31 +0000197 }
198}
199
200// ComputeUnsignedMinMaxValuesFromKnownBits - Given an unsigned integer type and
201// a set of known zero and one bits, compute the maximum and minimum values that
202// could have the specified known zero and known one bits, returning them in
203// min/max.
204static void ComputeUnsignedMinMaxValuesFromKnownBits(const APInt &KnownZero,
205 const APInt &KnownOne,
206 APInt &Min, APInt &Max) {
207 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
208 KnownZero.getBitWidth() == Min.getBitWidth() &&
209 KnownZero.getBitWidth() == Max.getBitWidth() &&
210 "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth.");
211 APInt UnknownBits = ~(KnownZero|KnownOne);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000212
Chris Lattner2188e402010-01-04 07:37:31 +0000213 // The minimum value is when the unknown bits are all zeros.
214 Min = KnownOne;
215 // The maximum value is when the unknown bits are all ones.
216 Max = KnownOne|UnknownBits;
217}
218
219
220
221/// FoldCmpLoadFromIndexedGlobal - Called we see this pattern:
222/// cmp pred (load (gep GV, ...)), cmpcst
223/// where GV is a global variable with a constant initializer. Try to simplify
224/// this into some simple computation that does not need the load. For example
225/// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
226///
227/// If AndCst is non-null, then the loaded value is masked with that constant
228/// before doing the comparison. This handles cases like "A[i]&4 == 0".
229Instruction *InstCombiner::
230FoldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP, GlobalVariable *GV,
231 CmpInst &ICI, ConstantInt *AndCst) {
Chris Lattnerfe741762012-01-31 02:55:06 +0000232 Constant *Init = GV->getInitializer();
233 if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
Craig Topperf40110f2014-04-25 05:29:35 +0000234 return nullptr;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000235
Chris Lattnerfe741762012-01-31 02:55:06 +0000236 uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
Craig Topperf40110f2014-04-25 05:29:35 +0000237 if (ArrayElementCount > 1024) return nullptr; // Don't blow up on huge arrays.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000238
Chris Lattner2188e402010-01-04 07:37:31 +0000239 // There are many forms of this optimization we can handle, for now, just do
240 // the simple index into a single-dimensional array.
241 //
242 // Require: GEP GV, 0, i {{, constant indices}}
243 if (GEP->getNumOperands() < 3 ||
244 !isa<ConstantInt>(GEP->getOperand(1)) ||
245 !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
246 isa<Constant>(GEP->getOperand(2)))
Craig Topperf40110f2014-04-25 05:29:35 +0000247 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000248
249 // Check that indices after the variable are constants and in-range for the
250 // type they index. Collect the indices. This is typically for arrays of
251 // structs.
252 SmallVector<unsigned, 4> LaterIndices;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000253
Chris Lattnerfe741762012-01-31 02:55:06 +0000254 Type *EltTy = Init->getType()->getArrayElementType();
Chris Lattner2188e402010-01-04 07:37:31 +0000255 for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
256 ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
Craig Topperf40110f2014-04-25 05:29:35 +0000257 if (!Idx) return nullptr; // Variable index.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000258
Chris Lattner2188e402010-01-04 07:37:31 +0000259 uint64_t IdxVal = Idx->getZExtValue();
Craig Topperf40110f2014-04-25 05:29:35 +0000260 if ((unsigned)IdxVal != IdxVal) return nullptr; // Too large array index.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000261
Chris Lattner229907c2011-07-18 04:54:35 +0000262 if (StructType *STy = dyn_cast<StructType>(EltTy))
Chris Lattner2188e402010-01-04 07:37:31 +0000263 EltTy = STy->getElementType(IdxVal);
Chris Lattner229907c2011-07-18 04:54:35 +0000264 else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
Craig Topperf40110f2014-04-25 05:29:35 +0000265 if (IdxVal >= ATy->getNumElements()) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000266 EltTy = ATy->getElementType();
267 } else {
Craig Topperf40110f2014-04-25 05:29:35 +0000268 return nullptr; // Unknown type.
Chris Lattner2188e402010-01-04 07:37:31 +0000269 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000270
Chris Lattner2188e402010-01-04 07:37:31 +0000271 LaterIndices.push_back(IdxVal);
272 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000273
Chris Lattner2188e402010-01-04 07:37:31 +0000274 enum { Overdefined = -3, Undefined = -2 };
275
276 // Variables for our state machines.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000277
Chris Lattner2188e402010-01-04 07:37:31 +0000278 // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
279 // "i == 47 | i == 87", where 47 is the first index the condition is true for,
280 // and 87 is the second (and last) index. FirstTrueElement is -2 when
281 // undefined, otherwise set to the first true element. SecondTrueElement is
282 // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
283 int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
284
285 // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
286 // form "i != 47 & i != 87". Same state transitions as for true elements.
287 int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000288
Chris Lattner2188e402010-01-04 07:37:31 +0000289 /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
290 /// define a state machine that triggers for ranges of values that the index
291 /// is true or false for. This triggers on things like "abbbbc"[i] == 'b'.
292 /// This is -2 when undefined, -3 when overdefined, and otherwise the last
293 /// index in the range (inclusive). We use -2 for undefined here because we
294 /// use relative comparisons and don't want 0-1 to match -1.
295 int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000296
Chris Lattner2188e402010-01-04 07:37:31 +0000297 // MagicBitvector - This is a magic bitvector where we set a bit if the
298 // comparison is true for element 'i'. If there are 64 elements or less in
299 // the array, this will fully represent all the comparison results.
300 uint64_t MagicBitvector = 0;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000301
Chris Lattner2188e402010-01-04 07:37:31 +0000302 // Scan the array and see if one of our patterns matches.
303 Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
Chris Lattnerfe741762012-01-31 02:55:06 +0000304 for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
305 Constant *Elt = Init->getAggregateElement(i);
Craig Topperf40110f2014-04-25 05:29:35 +0000306 if (!Elt) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000307
Chris Lattner2188e402010-01-04 07:37:31 +0000308 // If this is indexing an array of structures, get the structure element.
309 if (!LaterIndices.empty())
Jay Foad57aa6362011-07-13 10:26:04 +0000310 Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000311
Chris Lattner2188e402010-01-04 07:37:31 +0000312 // If the element is masked, handle it.
313 if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000314
Chris Lattner2188e402010-01-04 07:37:31 +0000315 // Find out if the comparison would be true or false for the i'th element.
316 Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000317 CompareRHS, DL, TLI);
Chris Lattner2188e402010-01-04 07:37:31 +0000318 // If the result is undef for this element, ignore it.
319 if (isa<UndefValue>(C)) {
320 // Extend range state machines to cover this element in case there is an
321 // undef in the middle of the range.
322 if (TrueRangeEnd == (int)i-1)
323 TrueRangeEnd = i;
324 if (FalseRangeEnd == (int)i-1)
325 FalseRangeEnd = i;
326 continue;
327 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000328
Chris Lattner2188e402010-01-04 07:37:31 +0000329 // If we can't compute the result for any of the elements, we have to give
330 // up evaluating the entire conditional.
Craig Topperf40110f2014-04-25 05:29:35 +0000331 if (!isa<ConstantInt>(C)) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000332
Chris Lattner2188e402010-01-04 07:37:31 +0000333 // Otherwise, we know if the comparison is true or false for this element,
334 // update our state machines.
335 bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000336
Chris Lattner2188e402010-01-04 07:37:31 +0000337 // State machine for single/double/range index comparison.
338 if (IsTrueForElt) {
339 // Update the TrueElement state machine.
340 if (FirstTrueElement == Undefined)
341 FirstTrueElement = TrueRangeEnd = i; // First true element.
342 else {
343 // Update double-compare state machine.
344 if (SecondTrueElement == Undefined)
345 SecondTrueElement = i;
346 else
347 SecondTrueElement = Overdefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000348
Chris Lattner2188e402010-01-04 07:37:31 +0000349 // Update range state machine.
350 if (TrueRangeEnd == (int)i-1)
351 TrueRangeEnd = i;
352 else
353 TrueRangeEnd = Overdefined;
354 }
355 } else {
356 // Update the FalseElement state machine.
357 if (FirstFalseElement == Undefined)
358 FirstFalseElement = FalseRangeEnd = i; // First false element.
359 else {
360 // Update double-compare state machine.
361 if (SecondFalseElement == Undefined)
362 SecondFalseElement = i;
363 else
364 SecondFalseElement = Overdefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000365
Chris Lattner2188e402010-01-04 07:37:31 +0000366 // Update range state machine.
367 if (FalseRangeEnd == (int)i-1)
368 FalseRangeEnd = i;
369 else
370 FalseRangeEnd = Overdefined;
371 }
372 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000373
374
Chris Lattner2188e402010-01-04 07:37:31 +0000375 // If this element is in range, update our magic bitvector.
376 if (i < 64 && IsTrueForElt)
377 MagicBitvector |= 1ULL << i;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000378
Chris Lattner2188e402010-01-04 07:37:31 +0000379 // If all of our states become overdefined, bail out early. Since the
380 // predicate is expensive, only check it every 8 elements. This is only
381 // really useful for really huge arrays.
382 if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
383 SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
384 FalseRangeEnd == Overdefined)
Craig Topperf40110f2014-04-25 05:29:35 +0000385 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000386 }
387
388 // Now that we've scanned the entire array, emit our new comparison(s). We
389 // order the state machines in complexity of the generated code.
390 Value *Idx = GEP->getOperand(2);
391
Matt Arsenault5aeae182013-08-19 21:40:31 +0000392 // If the index is larger than the pointer size of the target, truncate the
393 // index down like the GEP would do implicitly. We don't have to do this for
394 // an inbounds GEP because the index can't be out of range.
Matt Arsenault84680622013-09-30 21:11:01 +0000395 if (!GEP->isInBounds()) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000396 Type *IntPtrTy = DL.getIntPtrType(GEP->getType());
Matt Arsenault84680622013-09-30 21:11:01 +0000397 unsigned PtrSize = IntPtrTy->getIntegerBitWidth();
398 if (Idx->getType()->getPrimitiveSizeInBits() > PtrSize)
399 Idx = Builder->CreateTrunc(Idx, IntPtrTy);
400 }
Matt Arsenault5aeae182013-08-19 21:40:31 +0000401
Chris Lattner2188e402010-01-04 07:37:31 +0000402 // If the comparison is only true for one or two elements, emit direct
403 // comparisons.
404 if (SecondTrueElement != Overdefined) {
405 // None true -> false.
406 if (FirstTrueElement == Undefined)
Jakub Staszakbddea112013-06-06 20:18:46 +0000407 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000408
Chris Lattner2188e402010-01-04 07:37:31 +0000409 Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000410
Chris Lattner2188e402010-01-04 07:37:31 +0000411 // True for one element -> 'i == 47'.
412 if (SecondTrueElement == Undefined)
413 return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000414
Chris Lattner2188e402010-01-04 07:37:31 +0000415 // True for two elements -> 'i == 47 | i == 72'.
416 Value *C1 = Builder->CreateICmpEQ(Idx, FirstTrueIdx);
417 Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
418 Value *C2 = Builder->CreateICmpEQ(Idx, SecondTrueIdx);
419 return BinaryOperator::CreateOr(C1, C2);
420 }
421
422 // If the comparison is only false for one or two elements, emit direct
423 // comparisons.
424 if (SecondFalseElement != Overdefined) {
425 // None false -> true.
426 if (FirstFalseElement == Undefined)
Jakub Staszakbddea112013-06-06 20:18:46 +0000427 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000428
Chris Lattner2188e402010-01-04 07:37:31 +0000429 Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
430
431 // False for one element -> 'i != 47'.
432 if (SecondFalseElement == Undefined)
433 return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000434
Chris Lattner2188e402010-01-04 07:37:31 +0000435 // False for two elements -> 'i != 47 & i != 72'.
436 Value *C1 = Builder->CreateICmpNE(Idx, FirstFalseIdx);
437 Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
438 Value *C2 = Builder->CreateICmpNE(Idx, SecondFalseIdx);
439 return BinaryOperator::CreateAnd(C1, C2);
440 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000441
Chris Lattner2188e402010-01-04 07:37:31 +0000442 // If the comparison can be replaced with a range comparison for the elements
443 // where it is true, emit the range check.
444 if (TrueRangeEnd != Overdefined) {
445 assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
Jim Grosbach129c52a2011-09-30 18:09:53 +0000446
Chris Lattner2188e402010-01-04 07:37:31 +0000447 // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
448 if (FirstTrueElement) {
449 Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
450 Idx = Builder->CreateAdd(Idx, Offs);
451 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000452
Chris Lattner2188e402010-01-04 07:37:31 +0000453 Value *End = ConstantInt::get(Idx->getType(),
454 TrueRangeEnd-FirstTrueElement+1);
455 return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
456 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000457
Chris Lattner2188e402010-01-04 07:37:31 +0000458 // False range check.
459 if (FalseRangeEnd != Overdefined) {
460 assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
461 // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
462 if (FirstFalseElement) {
463 Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
464 Idx = Builder->CreateAdd(Idx, Offs);
465 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000466
Chris Lattner2188e402010-01-04 07:37:31 +0000467 Value *End = ConstantInt::get(Idx->getType(),
468 FalseRangeEnd-FirstFalseElement);
469 return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
470 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000471
472
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000473 // If a magic bitvector captures the entire comparison state
Chris Lattner2188e402010-01-04 07:37:31 +0000474 // of this load, replace it with computation that does:
475 // ((magic_cst >> i) & 1) != 0
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000476 {
Craig Topperf40110f2014-04-25 05:29:35 +0000477 Type *Ty = nullptr;
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000478
479 // Look for an appropriate type:
480 // - The type of Idx if the magic fits
481 // - The smallest fitting legal type if we have a DataLayout
482 // - Default to i32
483 if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
484 Ty = Idx->getType();
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000485 else
486 Ty = DL.getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000487
Craig Topperf40110f2014-04-25 05:29:35 +0000488 if (Ty) {
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000489 Value *V = Builder->CreateIntCast(Idx, Ty, false);
490 V = Builder->CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
491 V = Builder->CreateAnd(ConstantInt::get(Ty, 1), V);
492 return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
493 }
Chris Lattner2188e402010-01-04 07:37:31 +0000494 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000495
Craig Topperf40110f2014-04-25 05:29:35 +0000496 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000497}
498
499
500/// EvaluateGEPOffsetExpression - Return a value that can be used to compare
501/// the *offset* implied by a GEP to zero. For example, if we have &A[i], we
502/// want to return 'i' for "icmp ne i, 0". Note that, in general, indices can
503/// be complex, and scales are involved. The above expression would also be
504/// legal to codegen as "icmp ne (i*4), 0" (assuming A is a pointer to i32).
505/// This later form is less amenable to optimization though, and we are allowed
506/// to generate the first by knowing that pointer arithmetic doesn't overflow.
507///
508/// If we can't emit an optimized form for this expression, this returns null.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000509///
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000510static Value *EvaluateGEPOffsetExpression(User *GEP, InstCombiner &IC,
511 const DataLayout &DL) {
Chris Lattner2188e402010-01-04 07:37:31 +0000512 gep_type_iterator GTI = gep_type_begin(GEP);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000513
Chris Lattner2188e402010-01-04 07:37:31 +0000514 // Check to see if this gep only has a single variable index. If so, and if
515 // any constant indices are a multiple of its scale, then we can compute this
516 // in terms of the scale of the variable index. For example, if the GEP
517 // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
518 // because the expression will cross zero at the same point.
519 unsigned i, e = GEP->getNumOperands();
520 int64_t Offset = 0;
521 for (i = 1; i != e; ++i, ++GTI) {
522 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
523 // Compute the aggregate offset of constant indices.
524 if (CI->isZero()) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000525
Chris Lattner2188e402010-01-04 07:37:31 +0000526 // Handle a struct index, which adds its field offset to the pointer.
Chris Lattner229907c2011-07-18 04:54:35 +0000527 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000528 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
Chris Lattner2188e402010-01-04 07:37:31 +0000529 } else {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000530 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner2188e402010-01-04 07:37:31 +0000531 Offset += Size*CI->getSExtValue();
532 }
533 } else {
534 // Found our variable index.
535 break;
536 }
537 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000538
Chris Lattner2188e402010-01-04 07:37:31 +0000539 // If there are no variable indices, we must have a constant offset, just
540 // evaluate it the general way.
Craig Topperf40110f2014-04-25 05:29:35 +0000541 if (i == e) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000542
Chris Lattner2188e402010-01-04 07:37:31 +0000543 Value *VariableIdx = GEP->getOperand(i);
544 // Determine the scale factor of the variable element. For example, this is
545 // 4 if the variable index is into an array of i32.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000546 uint64_t VariableScale = DL.getTypeAllocSize(GTI.getIndexedType());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000547
Chris Lattner2188e402010-01-04 07:37:31 +0000548 // Verify that there are no other variable indices. If so, emit the hard way.
549 for (++i, ++GTI; i != e; ++i, ++GTI) {
550 ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
Craig Topperf40110f2014-04-25 05:29:35 +0000551 if (!CI) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000552
Chris Lattner2188e402010-01-04 07:37:31 +0000553 // Compute the aggregate offset of constant indices.
554 if (CI->isZero()) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000555
Chris Lattner2188e402010-01-04 07:37:31 +0000556 // Handle a struct index, which adds its field offset to the pointer.
Chris Lattner229907c2011-07-18 04:54:35 +0000557 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000558 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
Chris Lattner2188e402010-01-04 07:37:31 +0000559 } else {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000560 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner2188e402010-01-04 07:37:31 +0000561 Offset += Size*CI->getSExtValue();
562 }
563 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000564
Matt Arsenault745101d2013-08-21 19:53:10 +0000565
566
Chris Lattner2188e402010-01-04 07:37:31 +0000567 // Okay, we know we have a single variable index, which must be a
568 // pointer/array/vector index. If there is no offset, life is simple, return
569 // the index.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000570 Type *IntPtrTy = DL.getIntPtrType(GEP->getOperand(0)->getType());
Matt Arsenault745101d2013-08-21 19:53:10 +0000571 unsigned IntPtrWidth = IntPtrTy->getIntegerBitWidth();
Chris Lattner2188e402010-01-04 07:37:31 +0000572 if (Offset == 0) {
573 // Cast to intptrty in case a truncation occurs. If an extension is needed,
574 // we don't need to bother extending: the extension won't affect where the
575 // computation crosses zero.
Eli Friedman1754a252011-05-18 23:11:30 +0000576 if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) {
Eli Friedman1754a252011-05-18 23:11:30 +0000577 VariableIdx = IC.Builder->CreateTrunc(VariableIdx, IntPtrTy);
578 }
Chris Lattner2188e402010-01-04 07:37:31 +0000579 return VariableIdx;
580 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000581
Chris Lattner2188e402010-01-04 07:37:31 +0000582 // Otherwise, there is an index. The computation we will do will be modulo
583 // the pointer size, so get it.
584 uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000585
Chris Lattner2188e402010-01-04 07:37:31 +0000586 Offset &= PtrSizeMask;
587 VariableScale &= PtrSizeMask;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000588
Chris Lattner2188e402010-01-04 07:37:31 +0000589 // To do this transformation, any constant index must be a multiple of the
590 // variable scale factor. For example, we can evaluate "12 + 4*i" as "3 + i",
591 // but we can't evaluate "10 + 3*i" in terms of i. Check that the offset is a
592 // multiple of the variable scale.
593 int64_t NewOffs = Offset / (int64_t)VariableScale;
594 if (Offset != NewOffs*(int64_t)VariableScale)
Craig Topperf40110f2014-04-25 05:29:35 +0000595 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000596
Chris Lattner2188e402010-01-04 07:37:31 +0000597 // Okay, we can do this evaluation. Start by converting the index to intptr.
Chris Lattner2188e402010-01-04 07:37:31 +0000598 if (VariableIdx->getType() != IntPtrTy)
Eli Friedman1754a252011-05-18 23:11:30 +0000599 VariableIdx = IC.Builder->CreateIntCast(VariableIdx, IntPtrTy,
600 true /*Signed*/);
Chris Lattner2188e402010-01-04 07:37:31 +0000601 Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
Eli Friedman1754a252011-05-18 23:11:30 +0000602 return IC.Builder->CreateAdd(VariableIdx, OffsetVal, "offset");
Chris Lattner2188e402010-01-04 07:37:31 +0000603}
604
605/// FoldGEPICmp - Fold comparisons between a GEP instruction and something
606/// else. At this point we know that the GEP is on the LHS of the comparison.
607Instruction *InstCombiner::FoldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
608 ICmpInst::Predicate Cond,
609 Instruction &I) {
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000610 // Don't transform signed compares of GEPs into index compares. Even if the
611 // GEP is inbounds, the final add of the base pointer can have signed overflow
612 // and would change the result of the icmp.
613 // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
Benjamin Kramerc7a22fe2012-02-21 13:40:06 +0000614 // the maximum signed value for the pointer type.
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000615 if (ICmpInst::isSigned(Cond))
Craig Topperf40110f2014-04-25 05:29:35 +0000616 return nullptr;
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000617
Matt Arsenault44f60d02014-06-09 19:20:29 +0000618 // Look through bitcasts and addrspacecasts. We do not however want to remove
619 // 0 GEPs.
620 if (!isa<GetElementPtrInst>(RHS))
621 RHS = RHS->stripPointerCasts();
Chris Lattner2188e402010-01-04 07:37:31 +0000622
623 Value *PtrBase = GEPLHS->getOperand(0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000624 if (PtrBase == RHS && GEPLHS->isInBounds()) {
Chris Lattner2188e402010-01-04 07:37:31 +0000625 // ((gep Ptr, OFFSET) cmp Ptr) ---> (OFFSET cmp 0).
626 // This transformation (ignoring the base and scales) is valid because we
627 // know pointers can't overflow since the gep is inbounds. See if we can
628 // output an optimized form.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000629 Value *Offset = EvaluateGEPOffsetExpression(GEPLHS, *this, DL);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000630
Chris Lattner2188e402010-01-04 07:37:31 +0000631 // If not, synthesize the offset the hard way.
Craig Topperf40110f2014-04-25 05:29:35 +0000632 if (!Offset)
Chris Lattner2188e402010-01-04 07:37:31 +0000633 Offset = EmitGEPOffset(GEPLHS);
634 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
635 Constant::getNullValue(Offset->getType()));
636 } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
637 // If the base pointers are different, but the indices are the same, just
638 // compare the base pointer.
639 if (PtrBase != GEPRHS->getOperand(0)) {
640 bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
641 IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
642 GEPRHS->getOperand(0)->getType();
643 if (IndicesTheSame)
644 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
645 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
646 IndicesTheSame = false;
647 break;
648 }
649
650 // If all indices are the same, just compare the base pointers.
651 if (IndicesTheSame)
David Majnemer5953d372013-06-29 10:28:04 +0000652 return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +0000653
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000654 // If we're comparing GEPs with two base pointers that only differ in type
655 // and both GEPs have only constant indices or just one use, then fold
656 // the compare with the adjusted indices.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000657 if (GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000658 (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
659 (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
660 PtrBase->stripPointerCasts() ==
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000661 GEPRHS->getOperand(0)->stripPointerCasts()) {
Matt Arsenault44f60d02014-06-09 19:20:29 +0000662 Value *LOffset = EmitGEPOffset(GEPLHS);
663 Value *ROffset = EmitGEPOffset(GEPRHS);
664
665 // If we looked through an addrspacecast between different sized address
666 // spaces, the LHS and RHS pointers are different sized
667 // integers. Truncate to the smaller one.
668 Type *LHSIndexTy = LOffset->getType();
669 Type *RHSIndexTy = ROffset->getType();
670 if (LHSIndexTy != RHSIndexTy) {
671 if (LHSIndexTy->getPrimitiveSizeInBits() <
672 RHSIndexTy->getPrimitiveSizeInBits()) {
673 ROffset = Builder->CreateTrunc(ROffset, LHSIndexTy);
674 } else
675 LOffset = Builder->CreateTrunc(LOffset, RHSIndexTy);
676 }
677
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000678 Value *Cmp = Builder->CreateICmp(ICmpInst::getSignedPredicate(Cond),
Matt Arsenault44f60d02014-06-09 19:20:29 +0000679 LOffset, ROffset);
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000680 return ReplaceInstUsesWith(I, Cmp);
681 }
682
Chris Lattner2188e402010-01-04 07:37:31 +0000683 // Otherwise, the base pointers are different and the indices are
684 // different, bail out.
Craig Topperf40110f2014-04-25 05:29:35 +0000685 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000686 }
687
688 // If one of the GEPs has all zero indices, recurse.
Benjamin Kramerd0993e02014-07-07 11:01:16 +0000689 if (GEPLHS->hasAllZeroIndices())
Chris Lattner2188e402010-01-04 07:37:31 +0000690 return FoldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
David Majnemer92a8a7d2013-06-29 09:45:35 +0000691 ICmpInst::getSwappedPredicate(Cond), I);
Chris Lattner2188e402010-01-04 07:37:31 +0000692
693 // If the other GEP has all zero indices, recurse.
Benjamin Kramerd0993e02014-07-07 11:01:16 +0000694 if (GEPRHS->hasAllZeroIndices())
Chris Lattner2188e402010-01-04 07:37:31 +0000695 return FoldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
696
Stuart Hastings66a82b92011-05-14 05:55:10 +0000697 bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
Chris Lattner2188e402010-01-04 07:37:31 +0000698 if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) {
699 // If the GEPs only differ by one index, compare it.
700 unsigned NumDifferences = 0; // Keep track of # differences.
701 unsigned DiffOperand = 0; // The operand that differs.
702 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
703 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
704 if (GEPLHS->getOperand(i)->getType()->getPrimitiveSizeInBits() !=
705 GEPRHS->getOperand(i)->getType()->getPrimitiveSizeInBits()) {
706 // Irreconcilable differences.
707 NumDifferences = 2;
708 break;
709 } else {
710 if (NumDifferences++) break;
711 DiffOperand = i;
712 }
713 }
714
Rafael Espindolaa7bbc0b2013-06-06 17:03:05 +0000715 if (NumDifferences == 0) // SAME GEP?
716 return ReplaceInstUsesWith(I, // No comparison is needed here.
Jakub Staszakbddea112013-06-06 20:18:46 +0000717 Builder->getInt1(ICmpInst::isTrueWhenEqual(Cond)));
Chris Lattner2188e402010-01-04 07:37:31 +0000718
Stuart Hastings66a82b92011-05-14 05:55:10 +0000719 else if (NumDifferences == 1 && GEPsInBounds) {
Chris Lattner2188e402010-01-04 07:37:31 +0000720 Value *LHSV = GEPLHS->getOperand(DiffOperand);
721 Value *RHSV = GEPRHS->getOperand(DiffOperand);
722 // Make sure we do a signed comparison here.
723 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV);
724 }
725 }
726
727 // Only lower this if the icmp is the only user of the GEP or if we expect
728 // the result to fold to a constant!
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000729 if (GEPsInBounds && (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) &&
Chris Lattner2188e402010-01-04 07:37:31 +0000730 (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) {
731 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) ---> (OFFSET1 cmp OFFSET2)
732 Value *L = EmitGEPOffset(GEPLHS);
733 Value *R = EmitGEPOffset(GEPRHS);
734 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R);
735 }
736 }
Craig Topperf40110f2014-04-25 05:29:35 +0000737 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000738}
739
740/// FoldICmpAddOpCst - Fold "icmp pred (X+CI), X".
Benjamin Kramer0e2d1622013-09-20 22:12:42 +0000741Instruction *InstCombiner::FoldICmpAddOpCst(Instruction &ICI,
Chris Lattner2188e402010-01-04 07:37:31 +0000742 Value *X, ConstantInt *CI,
Benjamin Kramer0e2d1622013-09-20 22:12:42 +0000743 ICmpInst::Predicate Pred) {
Chris Lattner2188e402010-01-04 07:37:31 +0000744 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +0000745 // so the values can never be equal. Similarly for all other "or equals"
Chris Lattner2188e402010-01-04 07:37:31 +0000746 // operators.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000747
Chris Lattner8c92b572010-01-08 17:48:19 +0000748 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255
Chris Lattner2188e402010-01-04 07:37:31 +0000749 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253
750 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0
751 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
Jim Grosbach129c52a2011-09-30 18:09:53 +0000752 Value *R =
Chris Lattner8c92b572010-01-08 17:48:19 +0000753 ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI);
Chris Lattner2188e402010-01-04 07:37:31 +0000754 return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
755 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000756
Chris Lattner2188e402010-01-04 07:37:31 +0000757 // (X+1) >u X --> X <u (0-1) --> X != 255
758 // (X+2) >u X --> X <u (0-2) --> X <u 254
759 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0
Duncan Sandse5220012011-02-17 07:46:37 +0000760 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
Chris Lattner2188e402010-01-04 07:37:31 +0000761 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI));
Jim Grosbach129c52a2011-09-30 18:09:53 +0000762
Chris Lattner2188e402010-01-04 07:37:31 +0000763 unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits();
764 ConstantInt *SMax = ConstantInt::get(X->getContext(),
765 APInt::getSignedMaxValue(BitWidth));
766
767 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127
768 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125
769 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0
770 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1
771 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126
772 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127
Duncan Sandse5220012011-02-17 07:46:37 +0000773 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
Chris Lattner2188e402010-01-04 07:37:31 +0000774 return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI));
Jim Grosbach129c52a2011-09-30 18:09:53 +0000775
Chris Lattner2188e402010-01-04 07:37:31 +0000776 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127
777 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126
778 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
779 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
780 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126
781 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128
Jim Grosbach129c52a2011-09-30 18:09:53 +0000782
Chris Lattner2188e402010-01-04 07:37:31 +0000783 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
Jakub Staszakbddea112013-06-06 20:18:46 +0000784 Constant *C = Builder->getInt(CI->getValue()-1);
Chris Lattner2188e402010-01-04 07:37:31 +0000785 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C));
786}
787
788/// FoldICmpDivCst - Fold "icmp pred, ([su]div X, DivRHS), CmpRHS" where DivRHS
789/// and CmpRHS are both known to be integer constants.
790Instruction *InstCombiner::FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI,
791 ConstantInt *DivRHS) {
792 ConstantInt *CmpRHS = cast<ConstantInt>(ICI.getOperand(1));
793 const APInt &CmpRHSV = CmpRHS->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000794
795 // FIXME: If the operand types don't match the type of the divide
Chris Lattner2188e402010-01-04 07:37:31 +0000796 // then don't attempt this transform. The code below doesn't have the
797 // logic to deal with a signed divide and an unsigned compare (and
Jim Grosbach129c52a2011-09-30 18:09:53 +0000798 // vice versa). This is because (x /s C1) <s C2 produces different
Chris Lattner2188e402010-01-04 07:37:31 +0000799 // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even
Jim Grosbach129c52a2011-09-30 18:09:53 +0000800 // (x /u C1) <u C2. Simply casting the operands and result won't
801 // work. :( The if statement below tests that condition and bails
Chris Lattner98457102011-02-10 05:23:05 +0000802 // if it finds it.
Chris Lattner2188e402010-01-04 07:37:31 +0000803 bool DivIsSigned = DivI->getOpcode() == Instruction::SDiv;
804 if (!ICI.isEquality() && DivIsSigned != ICI.isSigned())
Craig Topperf40110f2014-04-25 05:29:35 +0000805 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000806 if (DivRHS->isZero())
Craig Topperf40110f2014-04-25 05:29:35 +0000807 return nullptr; // The ProdOV computation fails on divide by zero.
Chris Lattner2188e402010-01-04 07:37:31 +0000808 if (DivIsSigned && DivRHS->isAllOnesValue())
Craig Topperf40110f2014-04-25 05:29:35 +0000809 return nullptr; // The overflow computation also screws up here
Chris Lattner43273af2011-02-13 08:07:21 +0000810 if (DivRHS->isOne()) {
811 // This eliminates some funny cases with INT_MIN.
812 ICI.setOperand(0, DivI->getOperand(0)); // X/1 == X.
813 return &ICI;
814 }
Chris Lattner2188e402010-01-04 07:37:31 +0000815
816 // Compute Prod = CI * DivRHS. We are essentially solving an equation
Jim Grosbach129c52a2011-09-30 18:09:53 +0000817 // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and
818 // C2 (CI). By solving for X we can turn this into a range check
819 // instead of computing a divide.
Chris Lattner2188e402010-01-04 07:37:31 +0000820 Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS);
821
822 // Determine if the product overflows by seeing if the product is
823 // not equal to the divide. Make sure we do the same kind of divide
Jim Grosbach129c52a2011-09-30 18:09:53 +0000824 // as in the LHS instruction that we're folding.
Chris Lattner2188e402010-01-04 07:37:31 +0000825 bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) :
826 ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS;
827
828 // Get the ICmp opcode
829 ICmpInst::Predicate Pred = ICI.getPredicate();
830
Chris Lattner98457102011-02-10 05:23:05 +0000831 /// If the division is known to be exact, then there is no remainder from the
832 /// divide, so the covered range size is unit, otherwise it is the divisor.
833 ConstantInt *RangeSize = DivI->isExact() ? getOne(Prod) : DivRHS;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000834
Chris Lattner2188e402010-01-04 07:37:31 +0000835 // Figure out the interval that is being checked. For example, a comparison
Jim Grosbach129c52a2011-09-30 18:09:53 +0000836 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
Chris Lattner2188e402010-01-04 07:37:31 +0000837 // Compute this interval based on the constants involved and the signedness of
838 // the compare/divide. This computes a half-open interval, keeping track of
839 // whether either value in the interval overflows. After analysis each
840 // overflow variable is set to 0 if it's corresponding bound variable is valid
841 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
842 int LoOverflow = 0, HiOverflow = 0;
Craig Topperf40110f2014-04-25 05:29:35 +0000843 Constant *LoBound = nullptr, *HiBound = nullptr;
Chris Lattner98457102011-02-10 05:23:05 +0000844
Chris Lattner2188e402010-01-04 07:37:31 +0000845 if (!DivIsSigned) { // udiv
846 // e.g. X/5 op 3 --> [15, 20)
847 LoBound = Prod;
848 HiOverflow = LoOverflow = ProdOV;
Chris Lattner98457102011-02-10 05:23:05 +0000849 if (!HiOverflow) {
850 // If this is not an exact divide, then many values in the range collapse
851 // to the same result value.
852 HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false);
853 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000854
Chris Lattner2188e402010-01-04 07:37:31 +0000855 } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0.
856 if (CmpRHSV == 0) { // (X / pos) op 0
857 // Can't overflow. e.g. X/2 op 0 --> [-1, 2)
Chris Lattner98457102011-02-10 05:23:05 +0000858 LoBound = ConstantExpr::getNeg(SubOne(RangeSize));
859 HiBound = RangeSize;
Chris Lattner2188e402010-01-04 07:37:31 +0000860 } else if (CmpRHSV.isStrictlyPositive()) { // (X / pos) op pos
861 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20)
862 HiOverflow = LoOverflow = ProdOV;
863 if (!HiOverflow)
Chris Lattner98457102011-02-10 05:23:05 +0000864 HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true);
Chris Lattner2188e402010-01-04 07:37:31 +0000865 } else { // (X / pos) op neg
866 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14)
867 HiBound = AddOne(Prod);
868 LoOverflow = HiOverflow = ProdOV ? -1 : 0;
869 if (!LoOverflow) {
Chris Lattner98457102011-02-10 05:23:05 +0000870 ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +0000871 LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
Chris Lattner98457102011-02-10 05:23:05 +0000872 }
Chris Lattner2188e402010-01-04 07:37:31 +0000873 }
Chris Lattnerb1a15122011-07-15 06:08:15 +0000874 } else if (DivRHS->isNegative()) { // Divisor is < 0.
Chris Lattner98457102011-02-10 05:23:05 +0000875 if (DivI->isExact())
876 RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +0000877 if (CmpRHSV == 0) { // (X / neg) op 0
878 // e.g. X/-5 op 0 --> [-4, 5)
Chris Lattner98457102011-02-10 05:23:05 +0000879 LoBound = AddOne(RangeSize);
880 HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +0000881 if (HiBound == DivRHS) { // -INTMIN = INTMIN
882 HiOverflow = 1; // [INTMIN+1, overflow)
Craig Topperf40110f2014-04-25 05:29:35 +0000883 HiBound = nullptr; // e.g. X/INTMIN = 0 --> X > INTMIN
Chris Lattner2188e402010-01-04 07:37:31 +0000884 }
885 } else if (CmpRHSV.isStrictlyPositive()) { // (X / neg) op pos
886 // e.g. X/-5 op 3 --> [-19, -14)
887 HiBound = AddOne(Prod);
888 HiOverflow = LoOverflow = ProdOV ? -1 : 0;
889 if (!LoOverflow)
Chris Lattner98457102011-02-10 05:23:05 +0000890 LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
Chris Lattner2188e402010-01-04 07:37:31 +0000891 } else { // (X / neg) op neg
892 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20)
893 LoOverflow = HiOverflow = ProdOV;
894 if (!HiOverflow)
Chris Lattner98457102011-02-10 05:23:05 +0000895 HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true);
Chris Lattner2188e402010-01-04 07:37:31 +0000896 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000897
Chris Lattner2188e402010-01-04 07:37:31 +0000898 // Dividing by a negative swaps the condition. LT <-> GT
899 Pred = ICmpInst::getSwappedPredicate(Pred);
900 }
901
902 Value *X = DivI->getOperand(0);
903 switch (Pred) {
904 default: llvm_unreachable("Unhandled icmp opcode!");
905 case ICmpInst::ICMP_EQ:
906 if (LoOverflow && HiOverflow)
Jakub Staszakbddea112013-06-06 20:18:46 +0000907 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner067459c2010-03-05 08:46:26 +0000908 if (HiOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000909 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
910 ICmpInst::ICMP_UGE, X, LoBound);
Chris Lattner067459c2010-03-05 08:46:26 +0000911 if (LoOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000912 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
913 ICmpInst::ICMP_ULT, X, HiBound);
Chris Lattner98457102011-02-10 05:23:05 +0000914 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
915 DivIsSigned, true));
Chris Lattner2188e402010-01-04 07:37:31 +0000916 case ICmpInst::ICMP_NE:
917 if (LoOverflow && HiOverflow)
Jakub Staszakbddea112013-06-06 20:18:46 +0000918 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner067459c2010-03-05 08:46:26 +0000919 if (HiOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000920 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
921 ICmpInst::ICMP_ULT, X, LoBound);
Chris Lattner067459c2010-03-05 08:46:26 +0000922 if (LoOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000923 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
924 ICmpInst::ICMP_UGE, X, HiBound);
Chris Lattner067459c2010-03-05 08:46:26 +0000925 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
926 DivIsSigned, false));
Chris Lattner2188e402010-01-04 07:37:31 +0000927 case ICmpInst::ICMP_ULT:
928 case ICmpInst::ICMP_SLT:
929 if (LoOverflow == +1) // Low bound is greater than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000930 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +0000931 if (LoOverflow == -1) // Low bound is less than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000932 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +0000933 return new ICmpInst(Pred, X, LoBound);
934 case ICmpInst::ICMP_UGT:
935 case ICmpInst::ICMP_SGT:
936 if (HiOverflow == +1) // High bound greater than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000937 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner98457102011-02-10 05:23:05 +0000938 if (HiOverflow == -1) // High bound less than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000939 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +0000940 if (Pred == ICmpInst::ICMP_UGT)
941 return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound);
Chris Lattner98457102011-02-10 05:23:05 +0000942 return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound);
Chris Lattner2188e402010-01-04 07:37:31 +0000943 }
944}
945
Chris Lattnerd369f572011-02-13 07:43:07 +0000946/// FoldICmpShrCst - Handle "icmp(([al]shr X, cst1), cst2)".
947Instruction *InstCombiner::FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *Shr,
948 ConstantInt *ShAmt) {
Chris Lattnerd369f572011-02-13 07:43:07 +0000949 const APInt &CmpRHSV = cast<ConstantInt>(ICI.getOperand(1))->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000950
Chris Lattnerd369f572011-02-13 07:43:07 +0000951 // Check that the shift amount is in range. If not, don't perform
952 // undefined shifts. When the shift is visited it will be
953 // simplified.
954 uint32_t TypeBits = CmpRHSV.getBitWidth();
955 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
Chris Lattner43273af2011-02-13 08:07:21 +0000956 if (ShAmtVal >= TypeBits || ShAmtVal == 0)
Craig Topperf40110f2014-04-25 05:29:35 +0000957 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000958
Chris Lattner43273af2011-02-13 08:07:21 +0000959 if (!ICI.isEquality()) {
960 // If we have an unsigned comparison and an ashr, we can't simplify this.
961 // Similarly for signed comparisons with lshr.
962 if (ICI.isSigned() != (Shr->getOpcode() == Instruction::AShr))
Craig Topperf40110f2014-04-25 05:29:35 +0000963 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000964
Eli Friedman865866e2011-05-25 23:26:20 +0000965 // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv
966 // by a power of 2. Since we already have logic to simplify these,
967 // transform to div and then simplify the resultant comparison.
Chris Lattner43273af2011-02-13 08:07:21 +0000968 if (Shr->getOpcode() == Instruction::AShr &&
Eli Friedman865866e2011-05-25 23:26:20 +0000969 (!Shr->isExact() || ShAmtVal == TypeBits - 1))
Craig Topperf40110f2014-04-25 05:29:35 +0000970 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000971
Chris Lattner43273af2011-02-13 08:07:21 +0000972 // Revisit the shift (to delete it).
973 Worklist.Add(Shr);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000974
Chris Lattner43273af2011-02-13 08:07:21 +0000975 Constant *DivCst =
976 ConstantInt::get(Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal));
Jim Grosbach129c52a2011-09-30 18:09:53 +0000977
Chris Lattner43273af2011-02-13 08:07:21 +0000978 Value *Tmp =
979 Shr->getOpcode() == Instruction::AShr ?
980 Builder->CreateSDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()) :
981 Builder->CreateUDiv(Shr->getOperand(0), DivCst, "", Shr->isExact());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000982
Chris Lattner43273af2011-02-13 08:07:21 +0000983 ICI.setOperand(0, Tmp);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000984
Chris Lattner43273af2011-02-13 08:07:21 +0000985 // If the builder folded the binop, just return it.
986 BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp);
Craig Topperf40110f2014-04-25 05:29:35 +0000987 if (!TheDiv)
Chris Lattner43273af2011-02-13 08:07:21 +0000988 return &ICI;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000989
Chris Lattner43273af2011-02-13 08:07:21 +0000990 // Otherwise, fold this div/compare.
991 assert(TheDiv->getOpcode() == Instruction::SDiv ||
992 TheDiv->getOpcode() == Instruction::UDiv);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000993
Chris Lattner43273af2011-02-13 08:07:21 +0000994 Instruction *Res = FoldICmpDivCst(ICI, TheDiv, cast<ConstantInt>(DivCst));
995 assert(Res && "This div/cst should have folded!");
996 return Res;
997 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000998
999
Chris Lattnerd369f572011-02-13 07:43:07 +00001000 // If we are comparing against bits always shifted out, the
1001 // comparison cannot succeed.
1002 APInt Comp = CmpRHSV << ShAmtVal;
Jakub Staszakbddea112013-06-06 20:18:46 +00001003 ConstantInt *ShiftedCmpRHS = Builder->getInt(Comp);
Chris Lattnerd369f572011-02-13 07:43:07 +00001004 if (Shr->getOpcode() == Instruction::LShr)
1005 Comp = Comp.lshr(ShAmtVal);
1006 else
1007 Comp = Comp.ashr(ShAmtVal);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001008
Chris Lattnerd369f572011-02-13 07:43:07 +00001009 if (Comp != CmpRHSV) { // Comparing against a bit that we know is zero.
1010 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jakub Staszakbddea112013-06-06 20:18:46 +00001011 Constant *Cst = Builder->getInt1(IsICMP_NE);
Chris Lattnerd369f572011-02-13 07:43:07 +00001012 return ReplaceInstUsesWith(ICI, Cst);
1013 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001014
Chris Lattnerd369f572011-02-13 07:43:07 +00001015 // Otherwise, check to see if the bits shifted out are known to be zero.
1016 // If so, we can compare against the unshifted value:
1017 // (X & 4) >> 1 == 2 --> (X & 4) == 4.
Chris Lattner9bd7fdf2011-02-13 18:30:09 +00001018 if (Shr->hasOneUse() && Shr->isExact())
Chris Lattnerd369f572011-02-13 07:43:07 +00001019 return new ICmpInst(ICI.getPredicate(), Shr->getOperand(0), ShiftedCmpRHS);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001020
Chris Lattnerd369f572011-02-13 07:43:07 +00001021 if (Shr->hasOneUse()) {
1022 // Otherwise strength reduce the shift into an and.
1023 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
Jakub Staszakbddea112013-06-06 20:18:46 +00001024 Constant *Mask = Builder->getInt(Val);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001025
Chris Lattnerd369f572011-02-13 07:43:07 +00001026 Value *And = Builder->CreateAnd(Shr->getOperand(0),
1027 Mask, Shr->getName()+".mask");
1028 return new ICmpInst(ICI.getPredicate(), And, ShiftedCmpRHS);
1029 }
Craig Topperf40110f2014-04-25 05:29:35 +00001030 return nullptr;
Chris Lattnerd369f572011-02-13 07:43:07 +00001031}
1032
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001033/// FoldICmpCstShrCst - Handle "(icmp eq/ne (ashr/lshr const2, A), const1)" ->
1034/// (icmp eq/ne A, Log2(const2/const1)) ->
1035/// (icmp eq/ne A, Log2(const2) - Log2(const1)).
1036Instruction *InstCombiner::FoldICmpCstShrCst(ICmpInst &I, Value *Op, Value *A,
1037 ConstantInt *CI1,
1038 ConstantInt *CI2) {
1039 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1040
1041 auto getConstant = [&I, this](bool IsTrue) {
1042 if (I.getPredicate() == I.ICMP_NE)
1043 IsTrue = !IsTrue;
1044 return ReplaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
1045 };
1046
1047 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1048 if (I.getPredicate() == I.ICMP_NE)
1049 Pred = CmpInst::getInversePredicate(Pred);
1050 return new ICmpInst(Pred, LHS, RHS);
1051 };
1052
1053 APInt AP1 = CI1->getValue();
1054 APInt AP2 = CI2->getValue();
1055
David Majnemer2abb8182014-10-25 07:13:13 +00001056 // Don't bother doing any work for cases which InstSimplify handles.
1057 if (AP2 == 0)
1058 return nullptr;
1059 bool IsAShr = isa<AShrOperator>(Op);
1060 if (IsAShr) {
1061 if (AP2.isAllOnesValue())
1062 return nullptr;
1063 if (AP2.isNegative() != AP1.isNegative())
1064 return nullptr;
1065 if (AP2.sgt(AP1))
1066 return nullptr;
1067 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001068
David Majnemerd2056022014-10-21 19:51:55 +00001069 if (!AP1)
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001070 // 'A' must be large enough to shift out the highest set bit.
1071 return getICmp(I.ICMP_UGT, A,
1072 ConstantInt::get(A->getType(), AP2.logBase2()));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001073
David Majnemerd2056022014-10-21 19:51:55 +00001074 if (AP1 == AP2)
1075 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001076
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001077 // Get the distance between the highest bit that's set.
Andrea Di Biagio5b92b492014-09-17 11:32:31 +00001078 int Shift;
David Majnemerd2056022014-10-21 19:51:55 +00001079 // Both the constants are negative, take their positive to calculate log.
1080 if (IsAShr && AP1.isNegative())
Andrea Di Biagio458a6692014-10-09 12:41:49 +00001081 // Get the ones' complement of AP2 and AP1 when computing the distance.
1082 Shift = (~AP2).logBase2() - (~AP1).logBase2();
Andrea Di Biagio5b92b492014-09-17 11:32:31 +00001083 else
1084 Shift = AP2.logBase2() - AP1.logBase2();
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001085
David Majnemerd2056022014-10-21 19:51:55 +00001086 if (Shift > 0) {
1087 if (IsAShr ? AP1 == AP2.ashr(Shift) : AP1 == AP2.lshr(Shift))
1088 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1089 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001090 // Shifting const2 will never be equal to const1.
1091 return getConstant(false);
1092}
Chris Lattner2188e402010-01-04 07:37:31 +00001093
David Majnemer59939ac2014-10-19 08:23:08 +00001094/// FoldICmpCstShlCst - Handle "(icmp eq/ne (shl const2, A), const1)" ->
1095/// (icmp eq/ne A, TrailingZeros(const1) - TrailingZeros(const2)).
1096Instruction *InstCombiner::FoldICmpCstShlCst(ICmpInst &I, Value *Op, Value *A,
1097 ConstantInt *CI1,
1098 ConstantInt *CI2) {
1099 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1100
1101 auto getConstant = [&I, this](bool IsTrue) {
1102 if (I.getPredicate() == I.ICMP_NE)
1103 IsTrue = !IsTrue;
1104 return ReplaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
1105 };
1106
1107 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1108 if (I.getPredicate() == I.ICMP_NE)
1109 Pred = CmpInst::getInversePredicate(Pred);
1110 return new ICmpInst(Pred, LHS, RHS);
1111 };
1112
1113 APInt AP1 = CI1->getValue();
1114 APInt AP2 = CI2->getValue();
1115
David Majnemer2abb8182014-10-25 07:13:13 +00001116 // Don't bother doing any work for cases which InstSimplify handles.
1117 if (AP2 == 0)
1118 return nullptr;
David Majnemer59939ac2014-10-19 08:23:08 +00001119
1120 unsigned AP2TrailingZeros = AP2.countTrailingZeros();
1121
1122 if (!AP1 && AP2TrailingZeros != 0)
1123 return getICmp(I.ICMP_UGE, A,
1124 ConstantInt::get(A->getType(), AP2.getBitWidth() - AP2TrailingZeros));
1125
1126 if (AP1 == AP2)
1127 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1128
1129 // Get the distance between the lowest bits that are set.
1130 int Shift = AP1.countTrailingZeros() - AP2TrailingZeros;
1131
1132 if (Shift > 0 && AP2.shl(Shift) == AP1)
1133 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1134
1135 // Shifting const2 will never be equal to const1.
1136 return getConstant(false);
1137}
1138
Chris Lattner2188e402010-01-04 07:37:31 +00001139/// visitICmpInstWithInstAndIntCst - Handle "icmp (instr, intcst)".
1140///
1141Instruction *InstCombiner::visitICmpInstWithInstAndIntCst(ICmpInst &ICI,
1142 Instruction *LHSI,
1143 ConstantInt *RHS) {
1144 const APInt &RHSV = RHS->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00001145
Chris Lattner2188e402010-01-04 07:37:31 +00001146 switch (LHSI->getOpcode()) {
1147 case Instruction::Trunc:
1148 if (ICI.isEquality() && LHSI->hasOneUse()) {
1149 // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1150 // of the high bits truncated out of x are known.
1151 unsigned DstBits = LHSI->getType()->getPrimitiveSizeInBits(),
1152 SrcBits = LHSI->getOperand(0)->getType()->getPrimitiveSizeInBits();
Chris Lattner2188e402010-01-04 07:37:31 +00001153 APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0);
Hal Finkel60db0582014-09-07 18:57:58 +00001154 computeKnownBits(LHSI->getOperand(0), KnownZero, KnownOne, 0, &ICI);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001155
Chris Lattner2188e402010-01-04 07:37:31 +00001156 // If all the high bits are known, we can do this xform.
1157 if ((KnownZero|KnownOne).countLeadingOnes() >= SrcBits-DstBits) {
1158 // Pull in the high bits from known-ones set.
Jay Foad583abbc2010-12-07 08:25:19 +00001159 APInt NewRHS = RHS->getValue().zext(SrcBits);
Eli Friedmane0a64d82012-05-11 01:32:59 +00001160 NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits-DstBits);
Chris Lattner2188e402010-01-04 07:37:31 +00001161 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001162 Builder->getInt(NewRHS));
Chris Lattner2188e402010-01-04 07:37:31 +00001163 }
1164 }
1165 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001166
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001167 case Instruction::Xor: // (icmp pred (xor X, XorCst), CI)
1168 if (ConstantInt *XorCst = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00001169 // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1170 // fold the xor.
1171 if ((ICI.getPredicate() == ICmpInst::ICMP_SLT && RHSV == 0) ||
1172 (ICI.getPredicate() == ICmpInst::ICMP_SGT && RHSV.isAllOnesValue())) {
1173 Value *CompareVal = LHSI->getOperand(0);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001174
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001175 // If the sign bit of the XorCst is not set, there is no change to
Chris Lattner2188e402010-01-04 07:37:31 +00001176 // the operation, just stop using the Xor.
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001177 if (!XorCst->isNegative()) {
Chris Lattner2188e402010-01-04 07:37:31 +00001178 ICI.setOperand(0, CompareVal);
1179 Worklist.Add(LHSI);
1180 return &ICI;
1181 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001182
Chris Lattner2188e402010-01-04 07:37:31 +00001183 // Was the old condition true if the operand is positive?
1184 bool isTrueIfPositive = ICI.getPredicate() == ICmpInst::ICMP_SGT;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001185
Chris Lattner2188e402010-01-04 07:37:31 +00001186 // If so, the new one isn't.
1187 isTrueIfPositive ^= true;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001188
Chris Lattner2188e402010-01-04 07:37:31 +00001189 if (isTrueIfPositive)
1190 return new ICmpInst(ICmpInst::ICMP_SGT, CompareVal,
1191 SubOne(RHS));
1192 else
1193 return new ICmpInst(ICmpInst::ICMP_SLT, CompareVal,
1194 AddOne(RHS));
1195 }
1196
1197 if (LHSI->hasOneUse()) {
1198 // (icmp u/s (xor A SignBit), C) -> (icmp s/u A, (xor C SignBit))
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001199 if (!ICI.isEquality() && XorCst->getValue().isSignBit()) {
1200 const APInt &SignBit = XorCst->getValue();
Chris Lattner2188e402010-01-04 07:37:31 +00001201 ICmpInst::Predicate Pred = ICI.isSigned()
1202 ? ICI.getUnsignedPredicate()
1203 : ICI.getSignedPredicate();
1204 return new ICmpInst(Pred, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001205 Builder->getInt(RHSV ^ SignBit));
Chris Lattner2188e402010-01-04 07:37:31 +00001206 }
1207
1208 // (icmp u/s (xor A ~SignBit), C) -> (icmp s/u (xor C ~SignBit), A)
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001209 if (!ICI.isEquality() && XorCst->isMaxValue(true)) {
1210 const APInt &NotSignBit = XorCst->getValue();
Chris Lattner2188e402010-01-04 07:37:31 +00001211 ICmpInst::Predicate Pred = ICI.isSigned()
1212 ? ICI.getUnsignedPredicate()
1213 : ICI.getSignedPredicate();
1214 Pred = ICI.getSwappedPredicate(Pred);
1215 return new ICmpInst(Pred, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001216 Builder->getInt(RHSV ^ NotSignBit));
Chris Lattner2188e402010-01-04 07:37:31 +00001217 }
1218 }
David Majnemer72d76272013-07-09 09:20:58 +00001219
1220 // (icmp ugt (xor X, C), ~C) -> (icmp ult X, C)
1221 // iff -C is a power of 2
1222 if (ICI.getPredicate() == ICmpInst::ICMP_UGT &&
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001223 XorCst->getValue() == ~RHSV && (RHSV + 1).isPowerOf2())
1224 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0), XorCst);
David Majnemer72d76272013-07-09 09:20:58 +00001225
1226 // (icmp ult (xor X, C), -C) -> (icmp uge X, C)
1227 // iff -C is a power of 2
1228 if (ICI.getPredicate() == ICmpInst::ICMP_ULT &&
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001229 XorCst->getValue() == -RHSV && RHSV.isPowerOf2())
1230 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0), XorCst);
Chris Lattner2188e402010-01-04 07:37:31 +00001231 }
1232 break;
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001233 case Instruction::And: // (icmp pred (and X, AndCst), RHS)
Chris Lattner2188e402010-01-04 07:37:31 +00001234 if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) &&
1235 LHSI->getOperand(0)->hasOneUse()) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001236 ConstantInt *AndCst = cast<ConstantInt>(LHSI->getOperand(1));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001237
Chris Lattner2188e402010-01-04 07:37:31 +00001238 // If the LHS is an AND of a truncating cast, we can widen the
1239 // and/compare to be the input width without changing the value
1240 // produced, eliminating a cast.
1241 if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) {
1242 // We can do this transformation if either the AND constant does not
Jim Grosbach129c52a2011-09-30 18:09:53 +00001243 // have its sign bit set or if it is an equality comparison.
Chris Lattner2188e402010-01-04 07:37:31 +00001244 // Extending a relational comparison when we're checking the sign
1245 // bit would not work.
Benjamin Kramer35159c12011-06-12 22:47:53 +00001246 if (ICI.isEquality() ||
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001247 (!AndCst->isNegative() && RHSV.isNonNegative())) {
Benjamin Kramer35159c12011-06-12 22:47:53 +00001248 Value *NewAnd =
Chris Lattner2188e402010-01-04 07:37:31 +00001249 Builder->CreateAnd(Cast->getOperand(0),
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001250 ConstantExpr::getZExt(AndCst, Cast->getSrcTy()));
Benjamin Kramer35159c12011-06-12 22:47:53 +00001251 NewAnd->takeName(LHSI);
Chris Lattner2188e402010-01-04 07:37:31 +00001252 return new ICmpInst(ICI.getPredicate(), NewAnd,
Benjamin Kramer35159c12011-06-12 22:47:53 +00001253 ConstantExpr::getZExt(RHS, Cast->getSrcTy()));
Chris Lattner2188e402010-01-04 07:37:31 +00001254 }
1255 }
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001256
1257 // If the LHS is an AND of a zext, and we have an equality compare, we can
1258 // shrink the and/compare to the smaller type, eliminating the cast.
1259 if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) {
Chris Lattner229907c2011-07-18 04:54:35 +00001260 IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy());
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001261 // Make sure we don't compare the upper bits, SimplifyDemandedBits
1262 // should fold the icmp to true/false in that case.
1263 if (ICI.isEquality() && RHSV.getActiveBits() <= Ty->getBitWidth()) {
1264 Value *NewAnd =
1265 Builder->CreateAnd(Cast->getOperand(0),
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001266 ConstantExpr::getTrunc(AndCst, Ty));
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001267 NewAnd->takeName(LHSI);
1268 return new ICmpInst(ICI.getPredicate(), NewAnd,
1269 ConstantExpr::getTrunc(RHS, Ty));
1270 }
1271 }
1272
Chris Lattner2188e402010-01-04 07:37:31 +00001273 // If this is: (X >> C1) & C2 != C3 (where any shift and any compare
1274 // could exist), turn it into (X & (C2 << C1)) != (C3 << C1). This
1275 // happens a LOT in code produced by the C front-end, for bitfield
1276 // access.
1277 BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0));
1278 if (Shift && !Shift->isShift())
Craig Topperf40110f2014-04-25 05:29:35 +00001279 Shift = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001280
Chris Lattner2188e402010-01-04 07:37:31 +00001281 ConstantInt *ShAmt;
Craig Topperf40110f2014-04-25 05:29:35 +00001282 ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001283
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001284 // This seemingly simple opportunity to fold away a shift turns out to
1285 // be rather complicated. See PR17827
1286 // ( http://llvm.org/bugs/show_bug.cgi?id=17827 ) for details.
Chris Lattner2188e402010-01-04 07:37:31 +00001287 if (ShAmt) {
Kay Tiong Khoo5389f742013-12-02 18:43:59 +00001288 bool CanFold = false;
1289 unsigned ShiftOpcode = Shift->getOpcode();
1290 if (ShiftOpcode == Instruction::AShr) {
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001291 // There may be some constraints that make this possible,
1292 // but nothing simple has been discovered yet.
1293 CanFold = false;
1294 } else if (ShiftOpcode == Instruction::Shl) {
1295 // For a left shift, we can fold if the comparison is not signed.
1296 // We can also fold a signed comparison if the mask value and
1297 // comparison value are not negative. These constraints may not be
1298 // obvious, but we can prove that they are correct using an SMT
Kay Tiong Khooe37d5202013-12-19 18:35:54 +00001299 // solver.
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001300 if (!ICI.isSigned() || (!AndCst->isNegative() && !RHS->isNegative()))
Chris Lattner2188e402010-01-04 07:37:31 +00001301 CanFold = true;
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001302 } else if (ShiftOpcode == Instruction::LShr) {
1303 // For a logical right shift, we can fold if the comparison is not
1304 // signed. We can also fold a signed comparison if the shifted mask
1305 // value and the shifted comparison value are not negative.
1306 // These constraints may not be obvious, but we can prove that they
Kay Tiong Khooe37d5202013-12-19 18:35:54 +00001307 // are correct using an SMT solver.
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001308 if (!ICI.isSigned())
1309 CanFold = true;
1310 else {
1311 ConstantInt *ShiftedAndCst =
1312 cast<ConstantInt>(ConstantExpr::getShl(AndCst, ShAmt));
1313 ConstantInt *ShiftedRHSCst =
1314 cast<ConstantInt>(ConstantExpr::getShl(RHS, ShAmt));
1315
1316 if (!ShiftedAndCst->isNegative() && !ShiftedRHSCst->isNegative())
1317 CanFold = true;
1318 }
Chris Lattner2188e402010-01-04 07:37:31 +00001319 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001320
Chris Lattner2188e402010-01-04 07:37:31 +00001321 if (CanFold) {
1322 Constant *NewCst;
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001323 if (ShiftOpcode == Instruction::Shl)
Chris Lattner2188e402010-01-04 07:37:31 +00001324 NewCst = ConstantExpr::getLShr(RHS, ShAmt);
1325 else
1326 NewCst = ConstantExpr::getShl(RHS, ShAmt);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001327
Chris Lattner2188e402010-01-04 07:37:31 +00001328 // Check to see if we are shifting out any of the bits being
1329 // compared.
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001330 if (ConstantExpr::get(ShiftOpcode, NewCst, ShAmt) != RHS) {
Chris Lattner2188e402010-01-04 07:37:31 +00001331 // If we shifted bits out, the fold is not going to work out.
1332 // As a special case, check to see if this means that the
1333 // result is always true or false now.
1334 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
Jakub Staszakbddea112013-06-06 20:18:46 +00001335 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00001336 if (ICI.getPredicate() == ICmpInst::ICMP_NE)
Jakub Staszakbddea112013-06-06 20:18:46 +00001337 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00001338 } else {
1339 ICI.setOperand(1, NewCst);
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001340 Constant *NewAndCst;
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001341 if (ShiftOpcode == Instruction::Shl)
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001342 NewAndCst = ConstantExpr::getLShr(AndCst, ShAmt);
Chris Lattner2188e402010-01-04 07:37:31 +00001343 else
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001344 NewAndCst = ConstantExpr::getShl(AndCst, ShAmt);
1345 LHSI->setOperand(1, NewAndCst);
Chris Lattner2188e402010-01-04 07:37:31 +00001346 LHSI->setOperand(0, Shift->getOperand(0));
1347 Worklist.Add(Shift); // Shift is dead.
1348 return &ICI;
1349 }
1350 }
1351 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001352
Chris Lattner2188e402010-01-04 07:37:31 +00001353 // Turn ((X >> Y) & C) == 0 into (X & (C << Y)) == 0. The later is
1354 // preferable because it allows the C<<Y expression to be hoisted out
1355 // of a loop if Y is invariant and X is not.
1356 if (Shift && Shift->hasOneUse() && RHSV == 0 &&
1357 ICI.isEquality() && !Shift->isArithmeticShift() &&
1358 !isa<Constant>(Shift->getOperand(0))) {
1359 // Compute C << Y.
1360 Value *NS;
1361 if (Shift->getOpcode() == Instruction::LShr) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001362 NS = Builder->CreateShl(AndCst, Shift->getOperand(1));
Chris Lattner2188e402010-01-04 07:37:31 +00001363 } else {
1364 // Insert a logical shift.
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001365 NS = Builder->CreateLShr(AndCst, Shift->getOperand(1));
Chris Lattner2188e402010-01-04 07:37:31 +00001366 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001367
Chris Lattner2188e402010-01-04 07:37:31 +00001368 // Compute X & (C << Y).
Jim Grosbach129c52a2011-09-30 18:09:53 +00001369 Value *NewAnd =
Chris Lattner2188e402010-01-04 07:37:31 +00001370 Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName());
Jim Grosbach129c52a2011-09-30 18:09:53 +00001371
Chris Lattner2188e402010-01-04 07:37:31 +00001372 ICI.setOperand(0, NewAnd);
1373 return &ICI;
1374 }
Paul Redmond5917f4c2012-12-19 19:47:13 +00001375
David Majnemer0ffccf72014-08-24 09:10:57 +00001376 // (icmp pred (and (or (lshr X, Y), X), 1), 0) -->
1377 // (icmp pred (and X, (or (shl 1, Y), 1), 0))
1378 //
1379 // iff pred isn't signed
1380 {
1381 Value *X, *Y, *LShr;
1382 if (!ICI.isSigned() && RHSV == 0) {
1383 if (match(LHSI->getOperand(1), m_One())) {
1384 Constant *One = cast<Constant>(LHSI->getOperand(1));
1385 Value *Or = LHSI->getOperand(0);
1386 if (match(Or, m_Or(m_Value(LShr), m_Value(X))) &&
1387 match(LShr, m_LShr(m_Specific(X), m_Value(Y)))) {
1388 unsigned UsesRemoved = 0;
1389 if (LHSI->hasOneUse())
1390 ++UsesRemoved;
1391 if (Or->hasOneUse())
1392 ++UsesRemoved;
1393 if (LShr->hasOneUse())
1394 ++UsesRemoved;
1395 Value *NewOr = nullptr;
1396 // Compute X & ((1 << Y) | 1)
1397 if (auto *C = dyn_cast<Constant>(Y)) {
1398 if (UsesRemoved >= 1)
1399 NewOr =
1400 ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One);
1401 } else {
1402 if (UsesRemoved >= 3)
1403 NewOr = Builder->CreateOr(Builder->CreateShl(One, Y,
1404 LShr->getName(),
1405 /*HasNUW=*/true),
1406 One, Or->getName());
1407 }
1408 if (NewOr) {
1409 Value *NewAnd = Builder->CreateAnd(X, NewOr, LHSI->getName());
1410 ICI.setOperand(0, NewAnd);
1411 return &ICI;
1412 }
1413 }
1414 }
1415 }
1416 }
1417
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001418 // Replace ((X & AndCst) > RHSV) with ((X & AndCst) != 0), if any
1419 // bit set in (X & AndCst) will produce a result greater than RHSV.
Paul Redmond5917f4c2012-12-19 19:47:13 +00001420 if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001421 unsigned NTZ = AndCst->getValue().countTrailingZeros();
1422 if ((NTZ < AndCst->getBitWidth()) &&
1423 APInt::getOneBitSet(AndCst->getBitWidth(), NTZ).ugt(RHSV))
Paul Redmond5917f4c2012-12-19 19:47:13 +00001424 return new ICmpInst(ICmpInst::ICMP_NE, LHSI,
1425 Constant::getNullValue(RHS->getType()));
1426 }
Chris Lattner2188e402010-01-04 07:37:31 +00001427 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001428
Chris Lattner2188e402010-01-04 07:37:31 +00001429 // Try to optimize things like "A[i]&42 == 0" to index computations.
1430 if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) {
1431 if (GetElementPtrInst *GEP =
1432 dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1433 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1434 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1435 !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) {
1436 ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1));
1437 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV,ICI, C))
1438 return Res;
1439 }
1440 }
David Majnemer414d4e52013-07-09 08:09:32 +00001441
1442 // X & -C == -C -> X > u ~C
1443 // X & -C != -C -> X <= u ~C
1444 // iff C is a power of 2
1445 if (ICI.isEquality() && RHS == LHSI->getOperand(1) && (-RHSV).isPowerOf2())
1446 return new ICmpInst(
1447 ICI.getPredicate() == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_UGT
1448 : ICmpInst::ICMP_ULE,
1449 LHSI->getOperand(0), SubOne(RHS));
David Majnemerdfa3b092015-08-16 07:09:17 +00001450
1451 // (icmp eq (and %A, C), 0) -> (icmp sgt (trunc %A), -1)
1452 // iff C is a power of 2
1453 if (ICI.isEquality() && LHSI->hasOneUse() && match(RHS, m_Zero())) {
1454 if (auto *CI = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1455 const APInt &AI = CI->getValue();
1456 int32_t ExactLogBase2 = AI.exactLogBase2();
1457 if (ExactLogBase2 != -1 && DL.isLegalInteger(ExactLogBase2 + 1)) {
1458 Type *NTy = IntegerType::get(ICI.getContext(), ExactLogBase2 + 1);
1459 Value *Trunc = Builder->CreateTrunc(LHSI->getOperand(0), NTy);
1460 return new ICmpInst(ICI.getPredicate() == ICmpInst::ICMP_EQ
1461 ? ICmpInst::ICMP_SGE
1462 : ICmpInst::ICMP_SLT,
1463 Trunc, Constant::getNullValue(NTy));
1464 }
1465 }
1466 }
Chris Lattner2188e402010-01-04 07:37:31 +00001467 break;
1468
1469 case Instruction::Or: {
1470 if (!ICI.isEquality() || !RHS->isNullValue() || !LHSI->hasOneUse())
1471 break;
1472 Value *P, *Q;
1473 if (match(LHSI, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1474 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1475 // -> and (icmp eq P, null), (icmp eq Q, null).
Chris Lattner2188e402010-01-04 07:37:31 +00001476 Value *ICIP = Builder->CreateICmp(ICI.getPredicate(), P,
1477 Constant::getNullValue(P->getType()));
1478 Value *ICIQ = Builder->CreateICmp(ICI.getPredicate(), Q,
1479 Constant::getNullValue(Q->getType()));
1480 Instruction *Op;
1481 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1482 Op = BinaryOperator::CreateAnd(ICIP, ICIQ);
1483 else
1484 Op = BinaryOperator::CreateOr(ICIP, ICIQ);
1485 return Op;
1486 }
1487 break;
1488 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001489
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001490 case Instruction::Mul: { // (icmp pred (mul X, Val), CI)
1491 ConstantInt *Val = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1492 if (!Val) break;
1493
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +00001494 // If this is a signed comparison to 0 and the mul is sign preserving,
1495 // use the mul LHS operand instead.
1496 ICmpInst::Predicate pred = ICI.getPredicate();
1497 if (isSignTest(pred, RHS) && !Val->isZero() &&
1498 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1499 return new ICmpInst(Val->isNegative() ?
1500 ICmpInst::getSwappedPredicate(pred) : pred,
1501 LHSI->getOperand(0),
1502 Constant::getNullValue(RHS->getType()));
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001503
1504 break;
1505 }
1506
Chris Lattner2188e402010-01-04 07:37:31 +00001507 case Instruction::Shl: { // (icmp pred (shl X, ShAmt), CI)
Chris Lattner2188e402010-01-04 07:37:31 +00001508 uint32_t TypeBits = RHSV.getBitWidth();
David Majnemerb889e402013-06-28 23:42:03 +00001509 ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1510 if (!ShAmt) {
1511 Value *X;
1512 // (1 << X) pred P2 -> X pred Log2(P2)
1513 if (match(LHSI, m_Shl(m_One(), m_Value(X)))) {
1514 bool RHSVIsPowerOf2 = RHSV.isPowerOf2();
1515 ICmpInst::Predicate Pred = ICI.getPredicate();
1516 if (ICI.isUnsigned()) {
1517 if (!RHSVIsPowerOf2) {
1518 // (1 << X) < 30 -> X <= 4
1519 // (1 << X) <= 30 -> X <= 4
1520 // (1 << X) >= 30 -> X > 4
1521 // (1 << X) > 30 -> X > 4
1522 if (Pred == ICmpInst::ICMP_ULT)
1523 Pred = ICmpInst::ICMP_ULE;
1524 else if (Pred == ICmpInst::ICMP_UGE)
1525 Pred = ICmpInst::ICMP_UGT;
1526 }
1527 unsigned RHSLog2 = RHSV.logBase2();
1528
1529 // (1 << X) >= 2147483648 -> X >= 31 -> X == 31
David Majnemerb889e402013-06-28 23:42:03 +00001530 // (1 << X) < 2147483648 -> X < 31 -> X != 31
1531 if (RHSLog2 == TypeBits-1) {
1532 if (Pred == ICmpInst::ICMP_UGE)
1533 Pred = ICmpInst::ICMP_EQ;
David Majnemerb889e402013-06-28 23:42:03 +00001534 else if (Pred == ICmpInst::ICMP_ULT)
1535 Pred = ICmpInst::ICMP_NE;
1536 }
1537
1538 return new ICmpInst(Pred, X,
1539 ConstantInt::get(RHS->getType(), RHSLog2));
1540 } else if (ICI.isSigned()) {
1541 if (RHSV.isAllOnesValue()) {
1542 // (1 << X) <= -1 -> X == 31
1543 if (Pred == ICmpInst::ICMP_SLE)
1544 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1545 ConstantInt::get(RHS->getType(), TypeBits-1));
1546
1547 // (1 << X) > -1 -> X != 31
1548 if (Pred == ICmpInst::ICMP_SGT)
1549 return new ICmpInst(ICmpInst::ICMP_NE, X,
1550 ConstantInt::get(RHS->getType(), TypeBits-1));
1551 } else if (!RHSV) {
1552 // (1 << X) < 0 -> X == 31
1553 // (1 << X) <= 0 -> X == 31
1554 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1555 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1556 ConstantInt::get(RHS->getType(), TypeBits-1));
1557
1558 // (1 << X) >= 0 -> X != 31
1559 // (1 << X) > 0 -> X != 31
1560 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
1561 return new ICmpInst(ICmpInst::ICMP_NE, X,
1562 ConstantInt::get(RHS->getType(), TypeBits-1));
1563 }
1564 } else if (ICI.isEquality()) {
1565 if (RHSVIsPowerOf2)
1566 return new ICmpInst(
1567 Pred, X, ConstantInt::get(RHS->getType(), RHSV.logBase2()));
David Majnemerb889e402013-06-28 23:42:03 +00001568 }
1569 }
1570 break;
1571 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001572
Chris Lattner2188e402010-01-04 07:37:31 +00001573 // Check that the shift amount is in range. If not, don't perform
1574 // undefined shifts. When the shift is visited it will be
1575 // simplified.
1576 if (ShAmt->uge(TypeBits))
1577 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001578
Chris Lattner2188e402010-01-04 07:37:31 +00001579 if (ICI.isEquality()) {
1580 // If we are comparing against bits always shifted out, the
1581 // comparison cannot succeed.
1582 Constant *Comp =
1583 ConstantExpr::getShl(ConstantExpr::getLShr(RHS, ShAmt),
1584 ShAmt);
1585 if (Comp != RHS) {// Comparing against a bit that we know is zero.
1586 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jakub Staszakbddea112013-06-06 20:18:46 +00001587 Constant *Cst = Builder->getInt1(IsICMP_NE);
Chris Lattner2188e402010-01-04 07:37:31 +00001588 return ReplaceInstUsesWith(ICI, Cst);
1589 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001590
Chris Lattner98457102011-02-10 05:23:05 +00001591 // If the shift is NUW, then it is just shifting out zeros, no need for an
1592 // AND.
1593 if (cast<BinaryOperator>(LHSI)->hasNoUnsignedWrap())
1594 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1595 ConstantExpr::getLShr(RHS, ShAmt));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001596
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001597 // If the shift is NSW and we compare to 0, then it is just shifting out
1598 // sign bits, no need for an AND either.
1599 if (cast<BinaryOperator>(LHSI)->hasNoSignedWrap() && RHSV == 0)
1600 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1601 ConstantExpr::getLShr(RHS, ShAmt));
1602
Chris Lattner2188e402010-01-04 07:37:31 +00001603 if (LHSI->hasOneUse()) {
1604 // Otherwise strength reduce the shift into an and.
1605 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
Jakub Staszakbddea112013-06-06 20:18:46 +00001606 Constant *Mask = Builder->getInt(APInt::getLowBitsSet(TypeBits,
1607 TypeBits - ShAmtVal));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001608
Chris Lattner2188e402010-01-04 07:37:31 +00001609 Value *And =
1610 Builder->CreateAnd(LHSI->getOperand(0),Mask, LHSI->getName()+".mask");
1611 return new ICmpInst(ICI.getPredicate(), And,
Chris Lattner98457102011-02-10 05:23:05 +00001612 ConstantExpr::getLShr(RHS, ShAmt));
Chris Lattner2188e402010-01-04 07:37:31 +00001613 }
1614 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001615
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001616 // If this is a signed comparison to 0 and the shift is sign preserving,
1617 // use the shift LHS operand instead.
1618 ICmpInst::Predicate pred = ICI.getPredicate();
1619 if (isSignTest(pred, RHS) &&
1620 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1621 return new ICmpInst(pred,
1622 LHSI->getOperand(0),
1623 Constant::getNullValue(RHS->getType()));
1624
Chris Lattner2188e402010-01-04 07:37:31 +00001625 // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
1626 bool TrueIfSigned = false;
1627 if (LHSI->hasOneUse() &&
1628 isSignBitCheck(ICI.getPredicate(), RHS, TrueIfSigned)) {
1629 // (X << 31) <s 0 --> (X&1) != 0
Chris Lattner43273af2011-02-13 08:07:21 +00001630 Constant *Mask = ConstantInt::get(LHSI->getOperand(0)->getType(),
Jim Grosbach129c52a2011-09-30 18:09:53 +00001631 APInt::getOneBitSet(TypeBits,
Chris Lattner43273af2011-02-13 08:07:21 +00001632 TypeBits-ShAmt->getZExtValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00001633 Value *And =
1634 Builder->CreateAnd(LHSI->getOperand(0), Mask, LHSI->getName()+".mask");
1635 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
1636 And, Constant::getNullValue(And->getType()));
1637 }
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00001638
1639 // Transform (icmp pred iM (shl iM %v, N), CI)
Arnaud A. de Grandmaison71533052013-03-13 14:40:37 +00001640 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (CI>>N))
1641 // Transform the shl to a trunc if (trunc (CI>>N)) has no loss and M-N.
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00001642 // This enables to get rid of the shift in favor of a trunc which can be
1643 // free on the target. It has the additional benefit of comparing to a
1644 // smaller constant, which will be target friendly.
1645 unsigned Amt = ShAmt->getLimitedValue(TypeBits-1);
Arnaud A. de Grandmaison71533052013-03-13 14:40:37 +00001646 if (LHSI->hasOneUse() &&
1647 Amt != 0 && RHSV.countTrailingZeros() >= Amt) {
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00001648 Type *NTy = IntegerType::get(ICI.getContext(), TypeBits - Amt);
1649 Constant *NCI = ConstantExpr::getTrunc(
1650 ConstantExpr::getAShr(RHS,
1651 ConstantInt::get(RHS->getType(), Amt)),
1652 NTy);
1653 return new ICmpInst(ICI.getPredicate(),
1654 Builder->CreateTrunc(LHSI->getOperand(0), NTy),
Arnaud A. de Grandmaison1fd843e2013-02-15 15:18:17 +00001655 NCI);
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00001656 }
1657
Chris Lattner2188e402010-01-04 07:37:31 +00001658 break;
1659 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001660
Chris Lattner2188e402010-01-04 07:37:31 +00001661 case Instruction::LShr: // (icmp pred (shr X, ShAmt), CI)
Nick Lewycky174a7052011-02-28 08:31:40 +00001662 case Instruction::AShr: {
1663 // Handle equality comparisons of shift-by-constant.
1664 BinaryOperator *BO = cast<BinaryOperator>(LHSI);
1665 if (ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1666 if (Instruction *Res = FoldICmpShrCst(ICI, BO, ShAmt))
Chris Lattnerd369f572011-02-13 07:43:07 +00001667 return Res;
Nick Lewycky174a7052011-02-28 08:31:40 +00001668 }
1669
1670 // Handle exact shr's.
1671 if (ICI.isEquality() && BO->isExact() && BO->hasOneUse()) {
1672 if (RHSV.isMinValue())
1673 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), RHS);
1674 }
Chris Lattner2188e402010-01-04 07:37:31 +00001675 break;
Nick Lewycky174a7052011-02-28 08:31:40 +00001676 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001677
Chris Lattner2188e402010-01-04 07:37:31 +00001678 case Instruction::SDiv:
1679 case Instruction::UDiv:
1680 // Fold: icmp pred ([us]div X, C1), C2 -> range test
Jim Grosbach129c52a2011-09-30 18:09:53 +00001681 // Fold this div into the comparison, producing a range check.
1682 // Determine, based on the divide type, what the range is being
1683 // checked. If there is an overflow on the low or high side, remember
Chris Lattner2188e402010-01-04 07:37:31 +00001684 // it, otherwise compute the range [low, hi) bounding the new value.
1685 // See: InsertRangeTest above for the kinds of replacements possible.
1686 if (ConstantInt *DivRHS = dyn_cast<ConstantInt>(LHSI->getOperand(1)))
1687 if (Instruction *R = FoldICmpDivCst(ICI, cast<BinaryOperator>(LHSI),
1688 DivRHS))
1689 return R;
1690 break;
1691
David Majnemerf2a9a512013-07-09 07:50:59 +00001692 case Instruction::Sub: {
1693 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(0));
1694 if (!LHSC) break;
1695 const APInt &LHSV = LHSC->getValue();
1696
1697 // C1-X <u C2 -> (X|(C2-1)) == C1
1698 // iff C1 & (C2-1) == C2-1
1699 // C2 is a power of 2
1700 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
1701 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == (RHSV - 1))
1702 return new ICmpInst(ICmpInst::ICMP_EQ,
1703 Builder->CreateOr(LHSI->getOperand(1), RHSV - 1),
1704 LHSC);
1705
David Majnemereeed73b2013-07-09 09:24:35 +00001706 // C1-X >u C2 -> (X|C2) != C1
David Majnemerf2a9a512013-07-09 07:50:59 +00001707 // iff C1 & C2 == C2
1708 // C2+1 is a power of 2
1709 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1710 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == RHSV)
1711 return new ICmpInst(ICmpInst::ICMP_NE,
1712 Builder->CreateOr(LHSI->getOperand(1), RHSV), LHSC);
1713 break;
1714 }
1715
Chris Lattner2188e402010-01-04 07:37:31 +00001716 case Instruction::Add:
1717 // Fold: icmp pred (add X, C1), C2
1718 if (!ICI.isEquality()) {
1719 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1720 if (!LHSC) break;
1721 const APInt &LHSV = LHSC->getValue();
1722
1723 ConstantRange CR = ICI.makeConstantRange(ICI.getPredicate(), RHSV)
1724 .subtract(LHSV);
1725
1726 if (ICI.isSigned()) {
1727 if (CR.getLower().isSignBit()) {
1728 return new ICmpInst(ICmpInst::ICMP_SLT, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001729 Builder->getInt(CR.getUpper()));
Chris Lattner2188e402010-01-04 07:37:31 +00001730 } else if (CR.getUpper().isSignBit()) {
1731 return new ICmpInst(ICmpInst::ICMP_SGE, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001732 Builder->getInt(CR.getLower()));
Chris Lattner2188e402010-01-04 07:37:31 +00001733 }
1734 } else {
1735 if (CR.getLower().isMinValue()) {
1736 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001737 Builder->getInt(CR.getUpper()));
Chris Lattner2188e402010-01-04 07:37:31 +00001738 } else if (CR.getUpper().isMinValue()) {
1739 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001740 Builder->getInt(CR.getLower()));
Chris Lattner2188e402010-01-04 07:37:31 +00001741 }
1742 }
David Majnemerfa90a0b2013-07-08 11:53:08 +00001743
David Majnemerbafa5372013-07-09 07:58:32 +00001744 // X-C1 <u C2 -> (X & -C2) == C1
1745 // iff C1 & (C2-1) == 0
1746 // C2 is a power of 2
David Majnemerfa90a0b2013-07-08 11:53:08 +00001747 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
David Majnemerbafa5372013-07-09 07:58:32 +00001748 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == 0)
David Majnemerfa90a0b2013-07-08 11:53:08 +00001749 return new ICmpInst(ICmpInst::ICMP_EQ,
1750 Builder->CreateAnd(LHSI->getOperand(0), -RHSV),
1751 ConstantExpr::getNeg(LHSC));
David Majnemerbafa5372013-07-09 07:58:32 +00001752
David Majnemereeed73b2013-07-09 09:24:35 +00001753 // X-C1 >u C2 -> (X & ~C2) != C1
David Majnemerbafa5372013-07-09 07:58:32 +00001754 // iff C1 & C2 == 0
1755 // C2+1 is a power of 2
1756 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1757 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == 0)
1758 return new ICmpInst(ICmpInst::ICMP_NE,
1759 Builder->CreateAnd(LHSI->getOperand(0), ~RHSV),
1760 ConstantExpr::getNeg(LHSC));
Chris Lattner2188e402010-01-04 07:37:31 +00001761 }
1762 break;
1763 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001764
Chris Lattner2188e402010-01-04 07:37:31 +00001765 // Simplify icmp_eq and icmp_ne instructions with integer constant RHS.
1766 if (ICI.isEquality()) {
1767 bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001768
1769 // If the first operand is (add|sub|and|or|xor|rem) with a constant, and
Chris Lattner2188e402010-01-04 07:37:31 +00001770 // the second operand is a constant, simplify a bit.
1771 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(LHSI)) {
1772 switch (BO->getOpcode()) {
1773 case Instruction::SRem:
1774 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
1775 if (RHSV == 0 && isa<ConstantInt>(BO->getOperand(1)) &&BO->hasOneUse()){
1776 const APInt &V = cast<ConstantInt>(BO->getOperand(1))->getValue();
Dan Gohman4ce1fb12010-04-08 23:03:40 +00001777 if (V.sgt(1) && V.isPowerOf2()) {
Chris Lattner2188e402010-01-04 07:37:31 +00001778 Value *NewRem =
1779 Builder->CreateURem(BO->getOperand(0), BO->getOperand(1),
1780 BO->getName());
1781 return new ICmpInst(ICI.getPredicate(), NewRem,
1782 Constant::getNullValue(BO->getType()));
1783 }
1784 }
1785 break;
1786 case Instruction::Add:
1787 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
1788 if (ConstantInt *BOp1C = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1789 if (BO->hasOneUse())
1790 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1791 ConstantExpr::getSub(RHS, BOp1C));
1792 } else if (RHSV == 0) {
1793 // Replace ((add A, B) != 0) with (A != -B) if A or B is
1794 // efficiently invertible, or if the add has just this one use.
1795 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001796
Chris Lattner2188e402010-01-04 07:37:31 +00001797 if (Value *NegVal = dyn_castNegVal(BOp1))
1798 return new ICmpInst(ICI.getPredicate(), BOp0, NegVal);
Chris Lattner31b106d2011-04-26 20:02:45 +00001799 if (Value *NegVal = dyn_castNegVal(BOp0))
Chris Lattner2188e402010-01-04 07:37:31 +00001800 return new ICmpInst(ICI.getPredicate(), NegVal, BOp1);
Chris Lattner31b106d2011-04-26 20:02:45 +00001801 if (BO->hasOneUse()) {
Chris Lattner2188e402010-01-04 07:37:31 +00001802 Value *Neg = Builder->CreateNeg(BOp1);
1803 Neg->takeName(BO);
1804 return new ICmpInst(ICI.getPredicate(), BOp0, Neg);
1805 }
1806 }
1807 break;
1808 case Instruction::Xor:
1809 // For the xor case, we can xor two constants together, eliminating
1810 // the explicit xor.
Benjamin Kramerc9708492011-06-13 15:24:24 +00001811 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
1812 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
Chris Lattner2188e402010-01-04 07:37:31 +00001813 ConstantExpr::getXor(RHS, BOC));
Benjamin Kramerc9708492011-06-13 15:24:24 +00001814 } else if (RHSV == 0) {
1815 // Replace ((xor A, B) != 0) with (A != B)
Chris Lattner2188e402010-01-04 07:37:31 +00001816 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1817 BO->getOperand(1));
Benjamin Kramerc9708492011-06-13 15:24:24 +00001818 }
Chris Lattner2188e402010-01-04 07:37:31 +00001819 break;
Benjamin Kramerc9708492011-06-13 15:24:24 +00001820 case Instruction::Sub:
1821 // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants.
1822 if (ConstantInt *BOp0C = dyn_cast<ConstantInt>(BO->getOperand(0))) {
1823 if (BO->hasOneUse())
1824 return new ICmpInst(ICI.getPredicate(), BO->getOperand(1),
1825 ConstantExpr::getSub(BOp0C, RHS));
1826 } else if (RHSV == 0) {
1827 // Replace ((sub A, B) != 0) with (A != B)
1828 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1829 BO->getOperand(1));
1830 }
1831 break;
Chris Lattner2188e402010-01-04 07:37:31 +00001832 case Instruction::Or:
1833 // If bits are being or'd in that are not present in the constant we
1834 // are comparing against, then the comparison could never succeed!
Eli Friedman0428a612010-07-29 18:03:33 +00001835 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00001836 Constant *NotCI = ConstantExpr::getNot(RHS);
1837 if (!ConstantExpr::getAnd(BOC, NotCI)->isNullValue())
Jakub Staszakbddea112013-06-06 20:18:46 +00001838 return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
Chris Lattner2188e402010-01-04 07:37:31 +00001839 }
1840 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001841
Chris Lattner2188e402010-01-04 07:37:31 +00001842 case Instruction::And:
1843 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1844 // If bits are being compared against that are and'd out, then the
1845 // comparison can never succeed!
1846 if ((RHSV & ~BOC->getValue()) != 0)
Jakub Staszakbddea112013-06-06 20:18:46 +00001847 return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001848
Chris Lattner2188e402010-01-04 07:37:31 +00001849 // If we have ((X & C) == C), turn it into ((X & C) != 0).
1850 if (RHS == BOC && RHSV.isPowerOf2())
1851 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ :
1852 ICmpInst::ICMP_NE, LHSI,
1853 Constant::getNullValue(RHS->getType()));
Benjamin Kramer9eca5fe2011-07-04 20:16:36 +00001854
1855 // Don't perform the following transforms if the AND has multiple uses
1856 if (!BO->hasOneUse())
1857 break;
1858
Chris Lattner2188e402010-01-04 07:37:31 +00001859 // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
1860 if (BOC->getValue().isSignBit()) {
1861 Value *X = BO->getOperand(0);
1862 Constant *Zero = Constant::getNullValue(X->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00001863 ICmpInst::Predicate pred = isICMP_NE ?
Chris Lattner2188e402010-01-04 07:37:31 +00001864 ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
1865 return new ICmpInst(pred, X, Zero);
1866 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001867
Chris Lattner2188e402010-01-04 07:37:31 +00001868 // ((X & ~7) == 0) --> X < 8
1869 if (RHSV == 0 && isHighOnes(BOC)) {
1870 Value *X = BO->getOperand(0);
1871 Constant *NegX = ConstantExpr::getNeg(BOC);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001872 ICmpInst::Predicate pred = isICMP_NE ?
Chris Lattner2188e402010-01-04 07:37:31 +00001873 ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
1874 return new ICmpInst(pred, X, NegX);
1875 }
1876 }
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001877 break;
1878 case Instruction::Mul:
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +00001879 if (RHSV == 0 && BO->hasNoSignedWrap()) {
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001880 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1881 // The trivial case (mul X, 0) is handled by InstSimplify
1882 // General case : (mul X, C) != 0 iff X != 0
1883 // (mul X, C) == 0 iff X == 0
1884 if (!BOC->isZero())
1885 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1886 Constant::getNullValue(RHS->getType()));
1887 }
1888 }
1889 break;
Chris Lattner2188e402010-01-04 07:37:31 +00001890 default: break;
1891 }
1892 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(LHSI)) {
1893 // Handle icmp {eq|ne} <intrinsic>, intcst.
Chris Lattner54f4e392010-01-05 18:09:56 +00001894 switch (II->getIntrinsicID()) {
1895 case Intrinsic::bswap:
Chris Lattner2188e402010-01-04 07:37:31 +00001896 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00001897 ICI.setOperand(0, II->getArgOperand(0));
Jakub Staszakbddea112013-06-06 20:18:46 +00001898 ICI.setOperand(1, Builder->getInt(RHSV.byteSwap()));
Chris Lattner2188e402010-01-04 07:37:31 +00001899 return &ICI;
Chris Lattner54f4e392010-01-05 18:09:56 +00001900 case Intrinsic::ctlz:
1901 case Intrinsic::cttz:
1902 // ctz(A) == bitwidth(a) -> A == 0 and likewise for !=
1903 if (RHSV == RHS->getType()->getBitWidth()) {
1904 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00001905 ICI.setOperand(0, II->getArgOperand(0));
Chris Lattner54f4e392010-01-05 18:09:56 +00001906 ICI.setOperand(1, ConstantInt::get(RHS->getType(), 0));
1907 return &ICI;
1908 }
1909 break;
1910 case Intrinsic::ctpop:
1911 // popcount(A) == 0 -> A == 0 and likewise for !=
1912 if (RHS->isZero()) {
1913 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00001914 ICI.setOperand(0, II->getArgOperand(0));
Chris Lattner54f4e392010-01-05 18:09:56 +00001915 ICI.setOperand(1, RHS);
1916 return &ICI;
1917 }
1918 break;
1919 default:
Duncan Sands41b4a6b2010-07-12 08:16:59 +00001920 break;
Chris Lattner2188e402010-01-04 07:37:31 +00001921 }
1922 }
1923 }
Craig Topperf40110f2014-04-25 05:29:35 +00001924 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001925}
1926
1927/// visitICmpInstWithCastAndCast - Handle icmp (cast x to y), (cast/cst).
1928/// We only handle extending casts so far.
1929///
1930Instruction *InstCombiner::visitICmpInstWithCastAndCast(ICmpInst &ICI) {
1931 const CastInst *LHSCI = cast<CastInst>(ICI.getOperand(0));
1932 Value *LHSCIOp = LHSCI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00001933 Type *SrcTy = LHSCIOp->getType();
1934 Type *DestTy = LHSCI->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00001935 Value *RHSCIOp;
1936
Jim Grosbach129c52a2011-09-30 18:09:53 +00001937 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
Chris Lattner2188e402010-01-04 07:37:31 +00001938 // integer type is the same size as the pointer type.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001939 if (LHSCI->getOpcode() == Instruction::PtrToInt &&
1940 DL.getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth()) {
Craig Topperf40110f2014-04-25 05:29:35 +00001941 Value *RHSOp = nullptr;
Michael Liaod266b922015-02-13 04:51:26 +00001942 if (PtrToIntOperator *RHSC = dyn_cast<PtrToIntOperator>(ICI.getOperand(1))) {
1943 Value *RHSCIOp = RHSC->getOperand(0);
1944 if (RHSCIOp->getType()->getPointerAddressSpace() ==
1945 LHSCIOp->getType()->getPointerAddressSpace()) {
1946 RHSOp = RHSC->getOperand(0);
1947 // If the pointer types don't match, insert a bitcast.
1948 if (LHSCIOp->getType() != RHSOp->getType())
1949 RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType());
1950 }
1951 } else if (Constant *RHSC = dyn_cast<Constant>(ICI.getOperand(1)))
Chris Lattner2188e402010-01-04 07:37:31 +00001952 RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
Chris Lattner2188e402010-01-04 07:37:31 +00001953
1954 if (RHSOp)
1955 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSOp);
1956 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001957
Chris Lattner2188e402010-01-04 07:37:31 +00001958 // The code below only handles extension cast instructions, so far.
1959 // Enforce this.
1960 if (LHSCI->getOpcode() != Instruction::ZExt &&
1961 LHSCI->getOpcode() != Instruction::SExt)
Craig Topperf40110f2014-04-25 05:29:35 +00001962 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001963
1964 bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
1965 bool isSignedCmp = ICI.isSigned();
1966
1967 if (CastInst *CI = dyn_cast<CastInst>(ICI.getOperand(1))) {
1968 // Not an extension from the same type?
1969 RHSCIOp = CI->getOperand(0);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001970 if (RHSCIOp->getType() != LHSCIOp->getType())
Craig Topperf40110f2014-04-25 05:29:35 +00001971 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001972
Chris Lattner2188e402010-01-04 07:37:31 +00001973 // If the signedness of the two casts doesn't agree (i.e. one is a sext
1974 // and the other is a zext), then we can't handle this.
1975 if (CI->getOpcode() != LHSCI->getOpcode())
Craig Topperf40110f2014-04-25 05:29:35 +00001976 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001977
1978 // Deal with equality cases early.
1979 if (ICI.isEquality())
1980 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1981
1982 // A signed comparison of sign extended values simplifies into a
1983 // signed comparison.
1984 if (isSignedCmp && isSignedExt)
1985 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1986
1987 // The other three cases all fold into an unsigned comparison.
1988 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
1989 }
1990
1991 // If we aren't dealing with a constant on the RHS, exit early
1992 ConstantInt *CI = dyn_cast<ConstantInt>(ICI.getOperand(1));
1993 if (!CI)
Craig Topperf40110f2014-04-25 05:29:35 +00001994 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001995
1996 // Compute the constant that would happen if we truncated to SrcTy then
1997 // reextended to DestTy.
1998 Constant *Res1 = ConstantExpr::getTrunc(CI, SrcTy);
1999 Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(),
2000 Res1, DestTy);
2001
2002 // If the re-extended constant didn't change...
2003 if (Res2 == CI) {
2004 // Deal with equality cases early.
2005 if (ICI.isEquality())
2006 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
2007
2008 // A signed comparison of sign extended values simplifies into a
2009 // signed comparison.
2010 if (isSignedExt && isSignedCmp)
2011 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
2012
2013 // The other three cases all fold into an unsigned comparison.
2014 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, Res1);
2015 }
2016
Jim Grosbach129c52a2011-09-30 18:09:53 +00002017 // The re-extended constant changed so the constant cannot be represented
Chris Lattner2188e402010-01-04 07:37:31 +00002018 // in the shorter type. Consequently, we cannot emit a simple comparison.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002019 // All the cases that fold to true or false will have already been handled
2020 // by SimplifyICmpInst, so only deal with the tricky case.
Chris Lattner2188e402010-01-04 07:37:31 +00002021
Duncan Sands8fb2c382011-01-20 13:21:55 +00002022 if (isSignedCmp || !isSignedExt)
Craig Topperf40110f2014-04-25 05:29:35 +00002023 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002024
2025 // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
2026 // should have been folded away previously and not enter in here.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002027
2028 // We're performing an unsigned comp with a sign extended value.
2029 // This is true if the input is >= 0. [aka >s -1]
2030 Constant *NegOne = Constant::getAllOnesValue(SrcTy);
2031 Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICI.getName());
Chris Lattner2188e402010-01-04 07:37:31 +00002032
2033 // Finally, return the value computed.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002034 if (ICI.getPredicate() == ICmpInst::ICMP_ULT)
Chris Lattner2188e402010-01-04 07:37:31 +00002035 return ReplaceInstUsesWith(ICI, Result);
2036
Duncan Sands8fb2c382011-01-20 13:21:55 +00002037 assert(ICI.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
Chris Lattner2188e402010-01-04 07:37:31 +00002038 return BinaryOperator::CreateNot(Result);
2039}
2040
Chris Lattneree61c1d2010-12-19 17:52:50 +00002041/// ProcessUGT_ADDCST_ADD - The caller has matched a pattern of the form:
2042/// I = icmp ugt (add (add A, B), CI2), CI1
Chris Lattnerc56c8452010-12-19 18:22:06 +00002043/// If this is of the form:
2044/// sum = a + b
2045/// if (sum+128 >u 255)
2046/// Then replace it with llvm.sadd.with.overflow.i8.
2047///
Chris Lattneree61c1d2010-12-19 17:52:50 +00002048static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
2049 ConstantInt *CI2, ConstantInt *CI1,
Chris Lattnerce2995a2010-12-19 18:38:44 +00002050 InstCombiner &IC) {
Chris Lattnerf29562d2010-12-19 17:59:02 +00002051 // The transformation we're trying to do here is to transform this into an
2052 // llvm.sadd.with.overflow. To do this, we have to replace the original add
2053 // with a narrower add, and discard the add-with-constant that is part of the
2054 // range check (if we can't eliminate it, this isn't profitable).
Jim Grosbach129c52a2011-09-30 18:09:53 +00002055
Chris Lattnerf29562d2010-12-19 17:59:02 +00002056 // In order to eliminate the add-with-constant, the compare can be its only
2057 // use.
Chris Lattnerc56c8452010-12-19 18:22:06 +00002058 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
Craig Topperf40110f2014-04-25 05:29:35 +00002059 if (!AddWithCst->hasOneUse()) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002060
Chris Lattnerc56c8452010-12-19 18:22:06 +00002061 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
Craig Topperf40110f2014-04-25 05:29:35 +00002062 if (!CI2->getValue().isPowerOf2()) return nullptr;
Chris Lattnerc56c8452010-12-19 18:22:06 +00002063 unsigned NewWidth = CI2->getValue().countTrailingZeros();
Craig Topperf40110f2014-04-25 05:29:35 +00002064 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002065
Chris Lattnerc56c8452010-12-19 18:22:06 +00002066 // The width of the new add formed is 1 more than the bias.
2067 ++NewWidth;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002068
Chris Lattnerc56c8452010-12-19 18:22:06 +00002069 // Check to see that CI1 is an all-ones value with NewWidth bits.
2070 if (CI1->getBitWidth() == NewWidth ||
2071 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
Craig Topperf40110f2014-04-25 05:29:35 +00002072 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002073
Eli Friedmanb3f9b062011-11-28 23:32:19 +00002074 // This is only really a signed overflow check if the inputs have been
2075 // sign-extended; check for that condition. For example, if CI2 is 2^31 and
2076 // the operands of the add are 64 bits wide, we need at least 33 sign bits.
2077 unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
Hal Finkel60db0582014-09-07 18:57:58 +00002078 if (IC.ComputeNumSignBits(A, 0, &I) < NeededSignBits ||
2079 IC.ComputeNumSignBits(B, 0, &I) < NeededSignBits)
Craig Topperf40110f2014-04-25 05:29:35 +00002080 return nullptr;
Eli Friedmanb3f9b062011-11-28 23:32:19 +00002081
Jim Grosbach129c52a2011-09-30 18:09:53 +00002082 // In order to replace the original add with a narrower
Chris Lattnerc56c8452010-12-19 18:22:06 +00002083 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
2084 // and truncates that discard the high bits of the add. Verify that this is
2085 // the case.
2086 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
Chandler Carruthcdf47882014-03-09 03:16:01 +00002087 for (User *U : OrigAdd->users()) {
2088 if (U == AddWithCst) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002089
Chris Lattnerc56c8452010-12-19 18:22:06 +00002090 // Only accept truncates for now. We would really like a nice recursive
2091 // predicate like SimplifyDemandedBits, but which goes downwards the use-def
2092 // chain to see which bits of a value are actually demanded. If the
2093 // original add had another add which was then immediately truncated, we
2094 // could still do the transformation.
Chandler Carruthcdf47882014-03-09 03:16:01 +00002095 TruncInst *TI = dyn_cast<TruncInst>(U);
Craig Topperf40110f2014-04-25 05:29:35 +00002096 if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth)
2097 return nullptr;
Chris Lattnerc56c8452010-12-19 18:22:06 +00002098 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002099
Chris Lattneree61c1d2010-12-19 17:52:50 +00002100 // If the pattern matches, truncate the inputs to the narrower type and
2101 // use the sadd_with_overflow intrinsic to efficiently compute both the
2102 // result and the overflow bit.
Chris Lattner79874562010-12-19 18:35:09 +00002103 Module *M = I.getParent()->getParent()->getParent();
Jim Grosbach129c52a2011-09-30 18:09:53 +00002104
Jay Foadb804a2b2011-07-12 14:06:48 +00002105 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
Chris Lattner79874562010-12-19 18:35:09 +00002106 Value *F = Intrinsic::getDeclaration(M, Intrinsic::sadd_with_overflow,
Benjamin Kramere6e19332011-07-14 17:45:39 +00002107 NewType);
Chris Lattner79874562010-12-19 18:35:09 +00002108
Chris Lattnerce2995a2010-12-19 18:38:44 +00002109 InstCombiner::BuilderTy *Builder = IC.Builder;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002110
Chris Lattner79874562010-12-19 18:35:09 +00002111 // Put the new code above the original add, in case there are any uses of the
2112 // add between the add and the compare.
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002113 Builder->SetInsertPoint(OrigAdd);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002114
Chris Lattner79874562010-12-19 18:35:09 +00002115 Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc");
2116 Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc");
David Blaikieff6409d2015-05-18 22:13:54 +00002117 CallInst *Call = Builder->CreateCall(F, {TruncA, TruncB}, "sadd");
Chris Lattner79874562010-12-19 18:35:09 +00002118 Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result");
2119 Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00002120
Chris Lattneree61c1d2010-12-19 17:52:50 +00002121 // The inner add was the result of the narrow add, zero extended to the
2122 // wider type. Replace it with the result computed by the intrinsic.
Chris Lattnerce2995a2010-12-19 18:38:44 +00002123 IC.ReplaceInstUsesWith(*OrigAdd, ZExt);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002124
Chris Lattner79874562010-12-19 18:35:09 +00002125 // The original icmp gets replaced with the overflow value.
2126 return ExtractValueInst::Create(Call, 1, "sadd.overflow");
Chris Lattneree61c1d2010-12-19 17:52:50 +00002127}
Chris Lattner2188e402010-01-04 07:37:31 +00002128
Sanjoy Dasb0984472015-04-08 04:27:22 +00002129bool InstCombiner::OptimizeOverflowCheck(OverflowCheckFlavor OCF, Value *LHS,
2130 Value *RHS, Instruction &OrigI,
2131 Value *&Result, Constant *&Overflow) {
Sanjoy Das827529e2015-08-11 21:33:55 +00002132 if (OrigI.isCommutative() && isa<Constant>(LHS) && !isa<Constant>(RHS))
2133 std::swap(LHS, RHS);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002134
2135 auto SetResult = [&](Value *OpResult, Constant *OverflowVal, bool ReuseName) {
2136 Result = OpResult;
2137 Overflow = OverflowVal;
2138 if (ReuseName)
2139 Result->takeName(&OrigI);
2140 return true;
2141 };
2142
Sanjoy Das6f5dca72015-08-28 19:09:31 +00002143 // If the overflow check was an add followed by a compare, the insertion point
2144 // may be pointing to the compare. We want to insert the new instructions
2145 // before the add in case there are uses of the add between the add and the
2146 // compare.
2147 Builder->SetInsertPoint(&OrigI);
2148
Sanjoy Dasb0984472015-04-08 04:27:22 +00002149 switch (OCF) {
2150 case OCF_INVALID:
2151 llvm_unreachable("bad overflow check kind!");
2152
2153 case OCF_UNSIGNED_ADD: {
2154 OverflowResult OR = computeOverflowForUnsignedAdd(LHS, RHS, &OrigI);
2155 if (OR == OverflowResult::NeverOverflows)
2156 return SetResult(Builder->CreateNUWAdd(LHS, RHS), Builder->getFalse(),
2157 true);
2158
2159 if (OR == OverflowResult::AlwaysOverflows)
2160 return SetResult(Builder->CreateAdd(LHS, RHS), Builder->getTrue(), true);
2161 }
2162 // FALL THROUGH uadd into sadd
2163 case OCF_SIGNED_ADD: {
David Majnemer27e89ba2015-05-21 23:04:21 +00002164 // X + 0 -> {X, false}
2165 if (match(RHS, m_Zero()))
2166 return SetResult(LHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002167
2168 // We can strength reduce this signed add into a regular add if we can prove
2169 // that it will never overflow.
2170 if (OCF == OCF_SIGNED_ADD)
2171 if (WillNotOverflowSignedAdd(LHS, RHS, OrigI))
2172 return SetResult(Builder->CreateNSWAdd(LHS, RHS), Builder->getFalse(),
2173 true);
Sanjoy Das72cb5e12015-06-05 18:04:42 +00002174 break;
Sanjoy Dasb0984472015-04-08 04:27:22 +00002175 }
2176
2177 case OCF_UNSIGNED_SUB:
2178 case OCF_SIGNED_SUB: {
David Majnemer27e89ba2015-05-21 23:04:21 +00002179 // X - 0 -> {X, false}
2180 if (match(RHS, m_Zero()))
2181 return SetResult(LHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002182
2183 if (OCF == OCF_SIGNED_SUB) {
2184 if (WillNotOverflowSignedSub(LHS, RHS, OrigI))
2185 return SetResult(Builder->CreateNSWSub(LHS, RHS), Builder->getFalse(),
2186 true);
2187 } else {
2188 if (WillNotOverflowUnsignedSub(LHS, RHS, OrigI))
2189 return SetResult(Builder->CreateNUWSub(LHS, RHS), Builder->getFalse(),
2190 true);
2191 }
2192 break;
2193 }
2194
2195 case OCF_UNSIGNED_MUL: {
2196 OverflowResult OR = computeOverflowForUnsignedMul(LHS, RHS, &OrigI);
2197 if (OR == OverflowResult::NeverOverflows)
2198 return SetResult(Builder->CreateNUWMul(LHS, RHS), Builder->getFalse(),
2199 true);
2200 if (OR == OverflowResult::AlwaysOverflows)
2201 return SetResult(Builder->CreateMul(LHS, RHS), Builder->getTrue(), true);
2202 } // FALL THROUGH
2203 case OCF_SIGNED_MUL:
2204 // X * undef -> undef
2205 if (isa<UndefValue>(RHS))
David Majnemer27e89ba2015-05-21 23:04:21 +00002206 return SetResult(RHS, UndefValue::get(Builder->getInt1Ty()), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002207
David Majnemer27e89ba2015-05-21 23:04:21 +00002208 // X * 0 -> {0, false}
2209 if (match(RHS, m_Zero()))
2210 return SetResult(RHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002211
David Majnemer27e89ba2015-05-21 23:04:21 +00002212 // X * 1 -> {X, false}
2213 if (match(RHS, m_One()))
2214 return SetResult(LHS, Builder->getFalse(), false);
Sanjoy Dasb0984472015-04-08 04:27:22 +00002215
2216 if (OCF == OCF_SIGNED_MUL)
2217 if (WillNotOverflowSignedMul(LHS, RHS, OrigI))
2218 return SetResult(Builder->CreateNSWMul(LHS, RHS), Builder->getFalse(),
2219 true);
Sanjoy Dasc80dad62015-06-05 18:04:46 +00002220 break;
Sanjoy Dasb0984472015-04-08 04:27:22 +00002221 }
2222
2223 return false;
2224}
2225
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002226/// \brief Recognize and process idiom involving test for multiplication
2227/// overflow.
2228///
2229/// The caller has matched a pattern of the form:
2230/// I = cmp u (mul(zext A, zext B), V
2231/// The function checks if this is a test for overflow and if so replaces
2232/// multiplication with call to 'mul.with.overflow' intrinsic.
2233///
2234/// \param I Compare instruction.
2235/// \param MulVal Result of 'mult' instruction. It is one of the arguments of
2236/// the compare instruction. Must be of integer type.
2237/// \param OtherVal The other argument of compare instruction.
2238/// \returns Instruction which must replace the compare instruction, NULL if no
2239/// replacement required.
2240static Instruction *ProcessUMulZExtIdiom(ICmpInst &I, Value *MulVal,
2241 Value *OtherVal, InstCombiner &IC) {
Benjamin Kramerc96a7f82014-06-24 10:47:52 +00002242 // Don't bother doing this transformation for pointers, don't do it for
2243 // vectors.
2244 if (!isa<IntegerType>(MulVal->getType()))
2245 return nullptr;
2246
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002247 assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal);
2248 assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002249 Instruction *MulInstr = cast<Instruction>(MulVal);
2250 assert(MulInstr->getOpcode() == Instruction::Mul);
2251
David Majnemer634ca232014-11-01 23:46:05 +00002252 auto *LHS = cast<ZExtOperator>(MulInstr->getOperand(0)),
2253 *RHS = cast<ZExtOperator>(MulInstr->getOperand(1));
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002254 assert(LHS->getOpcode() == Instruction::ZExt);
2255 assert(RHS->getOpcode() == Instruction::ZExt);
2256 Value *A = LHS->getOperand(0), *B = RHS->getOperand(0);
2257
2258 // Calculate type and width of the result produced by mul.with.overflow.
2259 Type *TyA = A->getType(), *TyB = B->getType();
2260 unsigned WidthA = TyA->getPrimitiveSizeInBits(),
2261 WidthB = TyB->getPrimitiveSizeInBits();
2262 unsigned MulWidth;
2263 Type *MulType;
2264 if (WidthB > WidthA) {
2265 MulWidth = WidthB;
2266 MulType = TyB;
2267 } else {
2268 MulWidth = WidthA;
2269 MulType = TyA;
2270 }
2271
2272 // In order to replace the original mul with a narrower mul.with.overflow,
2273 // all uses must ignore upper bits of the product. The number of used low
2274 // bits must be not greater than the width of mul.with.overflow.
2275 if (MulVal->hasNUsesOrMore(2))
2276 for (User *U : MulVal->users()) {
2277 if (U == &I)
2278 continue;
2279 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2280 // Check if truncation ignores bits above MulWidth.
2281 unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits();
2282 if (TruncWidth > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00002283 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002284 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2285 // Check if AND ignores bits above MulWidth.
2286 if (BO->getOpcode() != Instruction::And)
Craig Topperf40110f2014-04-25 05:29:35 +00002287 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002288 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2289 const APInt &CVal = CI->getValue();
2290 if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00002291 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002292 }
2293 } else {
2294 // Other uses prohibit this transformation.
Craig Topperf40110f2014-04-25 05:29:35 +00002295 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002296 }
2297 }
2298
2299 // Recognize patterns
2300 switch (I.getPredicate()) {
2301 case ICmpInst::ICMP_EQ:
2302 case ICmpInst::ICMP_NE:
2303 // Recognize pattern:
2304 // mulval = mul(zext A, zext B)
2305 // cmp eq/neq mulval, zext trunc mulval
2306 if (ZExtInst *Zext = dyn_cast<ZExtInst>(OtherVal))
2307 if (Zext->hasOneUse()) {
2308 Value *ZextArg = Zext->getOperand(0);
2309 if (TruncInst *Trunc = dyn_cast<TruncInst>(ZextArg))
2310 if (Trunc->getType()->getPrimitiveSizeInBits() == MulWidth)
2311 break; //Recognized
2312 }
2313
2314 // Recognize pattern:
2315 // mulval = mul(zext A, zext B)
2316 // cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits.
2317 ConstantInt *CI;
2318 Value *ValToMask;
2319 if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) {
2320 if (ValToMask != MulVal)
Craig Topperf40110f2014-04-25 05:29:35 +00002321 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002322 const APInt &CVal = CI->getValue() + 1;
2323 if (CVal.isPowerOf2()) {
2324 unsigned MaskWidth = CVal.logBase2();
2325 if (MaskWidth == MulWidth)
2326 break; // Recognized
2327 }
2328 }
Craig Topperf40110f2014-04-25 05:29:35 +00002329 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002330
2331 case ICmpInst::ICMP_UGT:
2332 // Recognize pattern:
2333 // mulval = mul(zext A, zext B)
2334 // cmp ugt mulval, max
2335 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2336 APInt MaxVal = APInt::getMaxValue(MulWidth);
2337 MaxVal = MaxVal.zext(CI->getBitWidth());
2338 if (MaxVal.eq(CI->getValue()))
2339 break; // Recognized
2340 }
Craig Topperf40110f2014-04-25 05:29:35 +00002341 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002342
2343 case ICmpInst::ICMP_UGE:
2344 // Recognize pattern:
2345 // mulval = mul(zext A, zext B)
2346 // cmp uge mulval, max+1
2347 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2348 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
2349 if (MaxVal.eq(CI->getValue()))
2350 break; // Recognized
2351 }
Craig Topperf40110f2014-04-25 05:29:35 +00002352 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002353
2354 case ICmpInst::ICMP_ULE:
2355 // Recognize pattern:
2356 // mulval = mul(zext A, zext B)
2357 // cmp ule mulval, max
2358 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2359 APInt MaxVal = APInt::getMaxValue(MulWidth);
2360 MaxVal = MaxVal.zext(CI->getBitWidth());
2361 if (MaxVal.eq(CI->getValue()))
2362 break; // Recognized
2363 }
Craig Topperf40110f2014-04-25 05:29:35 +00002364 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002365
2366 case ICmpInst::ICMP_ULT:
2367 // Recognize pattern:
2368 // mulval = mul(zext A, zext B)
2369 // cmp ule mulval, max + 1
2370 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00002371 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002372 if (MaxVal.eq(CI->getValue()))
2373 break; // Recognized
2374 }
Craig Topperf40110f2014-04-25 05:29:35 +00002375 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002376
2377 default:
Craig Topperf40110f2014-04-25 05:29:35 +00002378 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002379 }
2380
2381 InstCombiner::BuilderTy *Builder = IC.Builder;
2382 Builder->SetInsertPoint(MulInstr);
2383 Module *M = I.getParent()->getParent()->getParent();
2384
2385 // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B)
2386 Value *MulA = A, *MulB = B;
2387 if (WidthA < MulWidth)
2388 MulA = Builder->CreateZExt(A, MulType);
2389 if (WidthB < MulWidth)
2390 MulB = Builder->CreateZExt(B, MulType);
2391 Value *F =
2392 Intrinsic::getDeclaration(M, Intrinsic::umul_with_overflow, MulType);
David Blaikieff6409d2015-05-18 22:13:54 +00002393 CallInst *Call = Builder->CreateCall(F, {MulA, MulB}, "umul");
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002394 IC.Worklist.Add(MulInstr);
2395
2396 // If there are uses of mul result other than the comparison, we know that
2397 // they are truncation or binary AND. Change them to use result of
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00002398 // mul.with.overflow and adjust properly mask/size.
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002399 if (MulVal->hasNUsesOrMore(2)) {
2400 Value *Mul = Builder->CreateExtractValue(Call, 0, "umul.value");
2401 for (User *U : MulVal->users()) {
2402 if (U == &I || U == OtherVal)
2403 continue;
2404 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2405 if (TI->getType()->getPrimitiveSizeInBits() == MulWidth)
2406 IC.ReplaceInstUsesWith(*TI, Mul);
2407 else
2408 TI->setOperand(0, Mul);
2409 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2410 assert(BO->getOpcode() == Instruction::And);
2411 // Replace (mul & mask) --> zext (mul.with.overflow & short_mask)
2412 ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
2413 APInt ShortMask = CI->getValue().trunc(MulWidth);
2414 Value *ShortAnd = Builder->CreateAnd(Mul, ShortMask);
2415 Instruction *Zext =
2416 cast<Instruction>(Builder->CreateZExt(ShortAnd, BO->getType()));
2417 IC.Worklist.Add(Zext);
2418 IC.ReplaceInstUsesWith(*BO, Zext);
2419 } else {
2420 llvm_unreachable("Unexpected Binary operation");
2421 }
2422 IC.Worklist.Add(cast<Instruction>(U));
2423 }
2424 }
2425 if (isa<Instruction>(OtherVal))
2426 IC.Worklist.Add(cast<Instruction>(OtherVal));
2427
2428 // The original icmp gets replaced with the overflow value, maybe inverted
2429 // depending on predicate.
2430 bool Inverse = false;
2431 switch (I.getPredicate()) {
2432 case ICmpInst::ICMP_NE:
2433 break;
2434 case ICmpInst::ICMP_EQ:
2435 Inverse = true;
2436 break;
2437 case ICmpInst::ICMP_UGT:
2438 case ICmpInst::ICMP_UGE:
2439 if (I.getOperand(0) == MulVal)
2440 break;
2441 Inverse = true;
2442 break;
2443 case ICmpInst::ICMP_ULT:
2444 case ICmpInst::ICMP_ULE:
2445 if (I.getOperand(1) == MulVal)
2446 break;
2447 Inverse = true;
2448 break;
2449 default:
2450 llvm_unreachable("Unexpected predicate");
2451 }
2452 if (Inverse) {
2453 Value *Res = Builder->CreateExtractValue(Call, 1);
2454 return BinaryOperator::CreateNot(Res);
2455 }
2456
2457 return ExtractValueInst::Create(Call, 1);
2458}
2459
Owen Andersond490c2d2011-01-11 00:36:45 +00002460// DemandedBitsLHSMask - When performing a comparison against a constant,
2461// it is possible that not all the bits in the LHS are demanded. This helper
2462// method computes the mask that IS demanded.
2463static APInt DemandedBitsLHSMask(ICmpInst &I,
2464 unsigned BitWidth, bool isSignCheck) {
2465 if (isSignCheck)
2466 return APInt::getSignBit(BitWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002467
Owen Andersond490c2d2011-01-11 00:36:45 +00002468 ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1));
2469 if (!CI) return APInt::getAllOnesValue(BitWidth);
Owen Anderson0022a4b2011-01-11 18:26:37 +00002470 const APInt &RHS = CI->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00002471
Owen Andersond490c2d2011-01-11 00:36:45 +00002472 switch (I.getPredicate()) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00002473 // For a UGT comparison, we don't care about any bits that
Owen Andersond490c2d2011-01-11 00:36:45 +00002474 // correspond to the trailing ones of the comparand. The value of these
2475 // bits doesn't impact the outcome of the comparison, because any value
2476 // greater than the RHS must differ in a bit higher than these due to carry.
2477 case ICmpInst::ICMP_UGT: {
2478 unsigned trailingOnes = RHS.countTrailingOnes();
2479 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes);
2480 return ~lowBitsSet;
2481 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002482
Owen Andersond490c2d2011-01-11 00:36:45 +00002483 // Similarly, for a ULT comparison, we don't care about the trailing zeros.
2484 // Any value less than the RHS must differ in a higher bit because of carries.
2485 case ICmpInst::ICMP_ULT: {
2486 unsigned trailingZeros = RHS.countTrailingZeros();
2487 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros);
2488 return ~lowBitsSet;
2489 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002490
Owen Andersond490c2d2011-01-11 00:36:45 +00002491 default:
2492 return APInt::getAllOnesValue(BitWidth);
2493 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002494
Owen Andersond490c2d2011-01-11 00:36:45 +00002495}
Chris Lattner2188e402010-01-04 07:37:31 +00002496
Quentin Colombet5ab55552013-09-09 20:56:48 +00002497/// \brief Check if the order of \p Op0 and \p Op1 as operand in an ICmpInst
2498/// should be swapped.
Alp Tokercb402912014-01-24 17:20:08 +00002499/// The decision is based on how many times these two operands are reused
Quentin Colombet5ab55552013-09-09 20:56:48 +00002500/// as subtract operands and their positions in those instructions.
2501/// The rational is that several architectures use the same instruction for
2502/// both subtract and cmp, thus it is better if the order of those operands
2503/// match.
2504/// \return true if Op0 and Op1 should be swapped.
2505static bool swapMayExposeCSEOpportunities(const Value * Op0,
2506 const Value * Op1) {
2507 // Filter out pointer value as those cannot appears directly in subtract.
2508 // FIXME: we may want to go through inttoptrs or bitcasts.
2509 if (Op0->getType()->isPointerTy())
2510 return false;
2511 // Count every uses of both Op0 and Op1 in a subtract.
2512 // Each time Op0 is the first operand, count -1: swapping is bad, the
2513 // subtract has already the same layout as the compare.
2514 // Each time Op0 is the second operand, count +1: swapping is good, the
Alp Tokercb402912014-01-24 17:20:08 +00002515 // subtract has a different layout as the compare.
Quentin Colombet5ab55552013-09-09 20:56:48 +00002516 // At the end, if the benefit is greater than 0, Op0 should come second to
2517 // expose more CSE opportunities.
2518 int GlobalSwapBenefits = 0;
Chandler Carruthcdf47882014-03-09 03:16:01 +00002519 for (const User *U : Op0->users()) {
2520 const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(U);
Quentin Colombet5ab55552013-09-09 20:56:48 +00002521 if (!BinOp || BinOp->getOpcode() != Instruction::Sub)
2522 continue;
2523 // If Op0 is the first argument, this is not beneficial to swap the
2524 // arguments.
2525 int LocalSwapBenefits = -1;
2526 unsigned Op1Idx = 1;
2527 if (BinOp->getOperand(Op1Idx) == Op0) {
2528 Op1Idx = 0;
2529 LocalSwapBenefits = 1;
2530 }
2531 if (BinOp->getOperand(Op1Idx) != Op1)
2532 continue;
2533 GlobalSwapBenefits += LocalSwapBenefits;
2534 }
2535 return GlobalSwapBenefits > 0;
2536}
2537
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00002538/// \brief Check that one use is in the same block as the definition and all
2539/// other uses are in blocks dominated by a given block
2540///
2541/// \param DI Definition
2542/// \param UI Use
2543/// \param DB Block that must dominate all uses of \p DI outside
2544/// the parent block
2545/// \return true when \p UI is the only use of \p DI in the parent block
2546/// and all other uses of \p DI are in blocks dominated by \p DB.
2547///
2548bool InstCombiner::dominatesAllUses(const Instruction *DI,
2549 const Instruction *UI,
2550 const BasicBlock *DB) const {
2551 assert(DI && UI && "Instruction not defined\n");
2552 // ignore incomplete definitions
2553 if (!DI->getParent())
2554 return false;
2555 // DI and UI must be in the same block
2556 if (DI->getParent() != UI->getParent())
2557 return false;
2558 // Protect from self-referencing blocks
2559 if (DI->getParent() == DB)
2560 return false;
2561 // DominatorTree available?
2562 if (!DT)
2563 return false;
2564 for (const User *U : DI->users()) {
2565 auto *Usr = cast<Instruction>(U);
2566 if (Usr != UI && !DT->dominates(DB, Usr->getParent()))
2567 return false;
2568 }
2569 return true;
2570}
2571
2572///
2573/// true when the instruction sequence within a block is select-cmp-br.
2574///
2575static bool isChainSelectCmpBranch(const SelectInst *SI) {
2576 const BasicBlock *BB = SI->getParent();
2577 if (!BB)
2578 return false;
2579 auto *BI = dyn_cast_or_null<BranchInst>(BB->getTerminator());
2580 if (!BI || BI->getNumSuccessors() != 2)
2581 return false;
2582 auto *IC = dyn_cast<ICmpInst>(BI->getCondition());
2583 if (!IC || (IC->getOperand(0) != SI && IC->getOperand(1) != SI))
2584 return false;
2585 return true;
2586}
2587
2588///
2589/// \brief True when a select result is replaced by one of its operands
2590/// in select-icmp sequence. This will eventually result in the elimination
2591/// of the select.
2592///
2593/// \param SI Select instruction
2594/// \param Icmp Compare instruction
2595/// \param SIOpd Operand that replaces the select
2596///
2597/// Notes:
2598/// - The replacement is global and requires dominator information
2599/// - The caller is responsible for the actual replacement
2600///
2601/// Example:
2602///
2603/// entry:
2604/// %4 = select i1 %3, %C* %0, %C* null
2605/// %5 = icmp eq %C* %4, null
2606/// br i1 %5, label %9, label %7
2607/// ...
2608/// ; <label>:7 ; preds = %entry
2609/// %8 = getelementptr inbounds %C* %4, i64 0, i32 0
2610/// ...
2611///
2612/// can be transformed to
2613///
2614/// %5 = icmp eq %C* %0, null
2615/// %6 = select i1 %3, i1 %5, i1 true
2616/// br i1 %6, label %9, label %7
2617/// ...
2618/// ; <label>:7 ; preds = %entry
2619/// %8 = getelementptr inbounds %C* %0, i64 0, i32 0 // replace by %0!
2620///
2621/// Similar when the first operand of the select is a constant or/and
2622/// the compare is for not equal rather than equal.
2623///
2624/// NOTE: The function is only called when the select and compare constants
2625/// are equal, the optimization can work only for EQ predicates. This is not a
2626/// major restriction since a NE compare should be 'normalized' to an equal
2627/// compare, which usually happens in the combiner and test case
2628/// select-cmp-br.ll
2629/// checks for it.
2630bool InstCombiner::replacedSelectWithOperand(SelectInst *SI,
2631 const ICmpInst *Icmp,
2632 const unsigned SIOpd) {
David Majnemer83484fd2014-11-22 06:09:28 +00002633 assert((SIOpd == 1 || SIOpd == 2) && "Invalid select operand!");
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00002634 if (isChainSelectCmpBranch(SI) && Icmp->getPredicate() == ICmpInst::ICMP_EQ) {
2635 BasicBlock *Succ = SI->getParent()->getTerminator()->getSuccessor(1);
2636 // The check for the unique predecessor is not the best that can be
2637 // done. But it protects efficiently against cases like when SI's
2638 // home block has two successors, Succ and Succ1, and Succ1 predecessor
2639 // of Succ. Then SI can't be replaced by SIOpd because the use that gets
2640 // replaced can be reached on either path. So the uniqueness check
2641 // guarantees that the path all uses of SI (outside SI's parent) are on
2642 // is disjoint from all other paths out of SI. But that information
2643 // is more expensive to compute, and the trade-off here is in favor
2644 // of compile-time.
2645 if (Succ->getUniquePredecessor() && dominatesAllUses(SI, Icmp, Succ)) {
2646 NumSel++;
2647 SI->replaceUsesOutsideBlock(SI->getOperand(SIOpd), SI->getParent());
2648 return true;
2649 }
2650 }
2651 return false;
2652}
2653
Chris Lattner2188e402010-01-04 07:37:31 +00002654Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
2655 bool Changed = false;
Chris Lattner9306ffa2010-02-01 19:54:45 +00002656 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Quentin Colombet5ab55552013-09-09 20:56:48 +00002657 unsigned Op0Cplxity = getComplexity(Op0);
2658 unsigned Op1Cplxity = getComplexity(Op1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002659
Chris Lattner2188e402010-01-04 07:37:31 +00002660 /// Orders the operands of the compare so that they are listed from most
2661 /// complex to least complex. This puts constants before unary operators,
2662 /// before binary operators.
Quentin Colombet5ab55552013-09-09 20:56:48 +00002663 if (Op0Cplxity < Op1Cplxity ||
2664 (Op0Cplxity == Op1Cplxity &&
2665 swapMayExposeCSEOpportunities(Op0, Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00002666 I.swapOperands();
Chris Lattner9306ffa2010-02-01 19:54:45 +00002667 std::swap(Op0, Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00002668 Changed = true;
2669 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002670
Jingyue Wu5e34ce32015-06-25 20:14:47 +00002671 if (Value *V =
2672 SimplifyICmpInst(I.getPredicate(), Op0, Op1, DL, TLI, DT, AC, &I))
Chris Lattner2188e402010-01-04 07:37:31 +00002673 return ReplaceInstUsesWith(I, V);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002674
Pete Cooperbc5c5242011-12-01 03:58:40 +00002675 // comparing -val or val with non-zero is the same as just comparing val
Pete Cooperfdddc272011-12-01 19:13:26 +00002676 // ie, abs(val) != 0 -> val != 0
Pete Cooperbc5c5242011-12-01 03:58:40 +00002677 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero()))
2678 {
Pete Cooperfdddc272011-12-01 19:13:26 +00002679 Value *Cond, *SelectTrue, *SelectFalse;
2680 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
Pete Cooperbc5c5242011-12-01 03:58:40 +00002681 m_Value(SelectFalse)))) {
Pete Cooperfdddc272011-12-01 19:13:26 +00002682 if (Value *V = dyn_castNegVal(SelectTrue)) {
2683 if (V == SelectFalse)
2684 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
2685 }
2686 else if (Value *V = dyn_castNegVal(SelectFalse)) {
2687 if (V == SelectTrue)
2688 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
Pete Cooperbc5c5242011-12-01 03:58:40 +00002689 }
2690 }
2691 }
2692
Chris Lattner229907c2011-07-18 04:54:35 +00002693 Type *Ty = Op0->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00002694
2695 // icmp's with boolean values can always be turned into bitwise operations
Duncan Sands9dff9be2010-02-15 16:12:20 +00002696 if (Ty->isIntegerTy(1)) {
Chris Lattner2188e402010-01-04 07:37:31 +00002697 switch (I.getPredicate()) {
2698 default: llvm_unreachable("Invalid icmp instruction!");
2699 case ICmpInst::ICMP_EQ: { // icmp eq i1 A, B -> ~(A^B)
2700 Value *Xor = Builder->CreateXor(Op0, Op1, I.getName()+"tmp");
2701 return BinaryOperator::CreateNot(Xor);
2702 }
2703 case ICmpInst::ICMP_NE: // icmp eq i1 A, B -> A^B
2704 return BinaryOperator::CreateXor(Op0, Op1);
2705
2706 case ICmpInst::ICMP_UGT:
2707 std::swap(Op0, Op1); // Change icmp ugt -> icmp ult
2708 // FALL THROUGH
2709 case ICmpInst::ICMP_ULT:{ // icmp ult i1 A, B -> ~A & B
2710 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2711 return BinaryOperator::CreateAnd(Not, Op1);
2712 }
2713 case ICmpInst::ICMP_SGT:
2714 std::swap(Op0, Op1); // Change icmp sgt -> icmp slt
2715 // FALL THROUGH
2716 case ICmpInst::ICMP_SLT: { // icmp slt i1 A, B -> A & ~B
2717 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2718 return BinaryOperator::CreateAnd(Not, Op0);
2719 }
2720 case ICmpInst::ICMP_UGE:
2721 std::swap(Op0, Op1); // Change icmp uge -> icmp ule
2722 // FALL THROUGH
2723 case ICmpInst::ICMP_ULE: { // icmp ule i1 A, B -> ~A | B
2724 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2725 return BinaryOperator::CreateOr(Not, Op1);
2726 }
2727 case ICmpInst::ICMP_SGE:
2728 std::swap(Op0, Op1); // Change icmp sge -> icmp sle
2729 // FALL THROUGH
2730 case ICmpInst::ICMP_SLE: { // icmp sle i1 A, B -> A | ~B
2731 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2732 return BinaryOperator::CreateOr(Not, Op0);
2733 }
2734 }
2735 }
2736
2737 unsigned BitWidth = 0;
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002738 if (Ty->isIntOrIntVectorTy())
Chris Lattner2188e402010-01-04 07:37:31 +00002739 BitWidth = Ty->getScalarSizeInBits();
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002740 else // Get pointer size.
2741 BitWidth = DL.getTypeSizeInBits(Ty->getScalarType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00002742
Chris Lattner2188e402010-01-04 07:37:31 +00002743 bool isSignBit = false;
2744
2745 // See if we are doing a comparison with a constant.
2746 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Craig Topperf40110f2014-04-25 05:29:35 +00002747 Value *A = nullptr, *B = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002748
Owen Anderson1294ea72010-12-17 18:08:00 +00002749 // Match the following pattern, which is a common idiom when writing
2750 // overflow-safe integer arithmetic function. The source performs an
2751 // addition in wider type, and explicitly checks for overflow using
2752 // comparisons against INT_MIN and INT_MAX. Simplify this by using the
2753 // sadd_with_overflow intrinsic.
Chris Lattneree61c1d2010-12-19 17:52:50 +00002754 //
2755 // TODO: This could probably be generalized to handle other overflow-safe
Jim Grosbach129c52a2011-09-30 18:09:53 +00002756 // operations if we worked out the formulas to compute the appropriate
Owen Anderson1294ea72010-12-17 18:08:00 +00002757 // magic constants.
Jim Grosbach129c52a2011-09-30 18:09:53 +00002758 //
Chris Lattneree61c1d2010-12-19 17:52:50 +00002759 // sum = a + b
2760 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8
Owen Anderson1294ea72010-12-17 18:08:00 +00002761 {
Chris Lattneree61c1d2010-12-19 17:52:50 +00002762 ConstantInt *CI2; // I = icmp ugt (add (add A, B), CI2), CI
Owen Anderson1294ea72010-12-17 18:08:00 +00002763 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
Chris Lattneree61c1d2010-12-19 17:52:50 +00002764 match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
Chris Lattnerce2995a2010-12-19 18:38:44 +00002765 if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this))
Chris Lattneree61c1d2010-12-19 17:52:50 +00002766 return Res;
Owen Anderson1294ea72010-12-17 18:08:00 +00002767 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002768
David Majnemera0afb552015-01-14 19:26:56 +00002769 // The following transforms are only 'worth it' if the only user of the
2770 // subtraction is the icmp.
2771 if (Op0->hasOneUse()) {
2772 // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B)
2773 if (I.isEquality() && CI->isZero() &&
2774 match(Op0, m_Sub(m_Value(A), m_Value(B))))
2775 return new ICmpInst(I.getPredicate(), A, B);
2776
2777 // (icmp sgt (sub nsw A B), -1) -> (icmp sge A, B)
2778 if (I.getPredicate() == ICmpInst::ICMP_SGT && CI->isAllOnesValue() &&
2779 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
2780 return new ICmpInst(ICmpInst::ICMP_SGE, A, B);
2781
2782 // (icmp sgt (sub nsw A B), 0) -> (icmp sgt A, B)
2783 if (I.getPredicate() == ICmpInst::ICMP_SGT && CI->isZero() &&
2784 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
2785 return new ICmpInst(ICmpInst::ICMP_SGT, A, B);
2786
2787 // (icmp slt (sub nsw A B), 0) -> (icmp slt A, B)
2788 if (I.getPredicate() == ICmpInst::ICMP_SLT && CI->isZero() &&
2789 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
2790 return new ICmpInst(ICmpInst::ICMP_SLT, A, B);
2791
2792 // (icmp slt (sub nsw A B), 1) -> (icmp sle A, B)
2793 if (I.getPredicate() == ICmpInst::ICMP_SLT && CI->isOne() &&
2794 match(Op0, m_NSWSub(m_Value(A), m_Value(B))))
2795 return new ICmpInst(ICmpInst::ICMP_SLE, A, B);
Chris Lattner2188e402010-01-04 07:37:31 +00002796 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002797
Chris Lattner2188e402010-01-04 07:37:31 +00002798 // If we have an icmp le or icmp ge instruction, turn it into the
2799 // appropriate icmp lt or icmp gt instruction. This allows us to rely on
2800 // them being folded in the code below. The SimplifyICmpInst code has
2801 // already handled the edge cases for us, so we just assert on them.
2802 switch (I.getPredicate()) {
2803 default: break;
2804 case ICmpInst::ICMP_ULE:
2805 assert(!CI->isMaxValue(false)); // A <=u MAX -> TRUE
2806 return new ICmpInst(ICmpInst::ICMP_ULT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002807 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00002808 case ICmpInst::ICMP_SLE:
2809 assert(!CI->isMaxValue(true)); // A <=s MAX -> TRUE
2810 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002811 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00002812 case ICmpInst::ICMP_UGE:
Nick Lewycky6b4454192011-02-28 06:20:05 +00002813 assert(!CI->isMinValue(false)); // A >=u MIN -> TRUE
Chris Lattner2188e402010-01-04 07:37:31 +00002814 return new ICmpInst(ICmpInst::ICMP_UGT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002815 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002816 case ICmpInst::ICMP_SGE:
Nick Lewycky6b4454192011-02-28 06:20:05 +00002817 assert(!CI->isMinValue(true)); // A >=s MIN -> TRUE
Chris Lattner2188e402010-01-04 07:37:31 +00002818 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002819 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002820 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002821
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00002822 if (I.isEquality()) {
2823 ConstantInt *CI2;
2824 if (match(Op0, m_AShr(m_ConstantInt(CI2), m_Value(A))) ||
2825 match(Op0, m_LShr(m_ConstantInt(CI2), m_Value(A)))) {
David Majnemer59939ac2014-10-19 08:23:08 +00002826 // (icmp eq/ne (ashr/lshr const2, A), const1)
David Majnemer2abb8182014-10-25 07:13:13 +00002827 if (Instruction *Inst = FoldICmpCstShrCst(I, Op0, A, CI, CI2))
2828 return Inst;
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00002829 }
David Majnemer59939ac2014-10-19 08:23:08 +00002830 if (match(Op0, m_Shl(m_ConstantInt(CI2), m_Value(A)))) {
2831 // (icmp eq/ne (shl const2, A), const1)
David Majnemer2abb8182014-10-25 07:13:13 +00002832 if (Instruction *Inst = FoldICmpCstShlCst(I, Op0, A, CI, CI2))
2833 return Inst;
David Majnemer59939ac2014-10-19 08:23:08 +00002834 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00002835 }
2836
Chris Lattner2188e402010-01-04 07:37:31 +00002837 // If this comparison is a normal comparison, it demands all
2838 // bits, if it is a sign bit comparison, it only demands the sign bit.
2839 bool UnusedBit;
2840 isSignBit = isSignBitCheck(I.getPredicate(), CI, UnusedBit);
2841 }
2842
2843 // See if we can fold the comparison based on range information we can get
2844 // by checking whether bits are known to be zero or one in the input.
2845 if (BitWidth != 0) {
2846 APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0);
2847 APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0);
2848
2849 if (SimplifyDemandedBits(I.getOperandUse(0),
Owen Andersond490c2d2011-01-11 00:36:45 +00002850 DemandedBitsLHSMask(I, BitWidth, isSignBit),
Chris Lattner2188e402010-01-04 07:37:31 +00002851 Op0KnownZero, Op0KnownOne, 0))
2852 return &I;
2853 if (SimplifyDemandedBits(I.getOperandUse(1),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002854 APInt::getAllOnesValue(BitWidth), Op1KnownZero,
2855 Op1KnownOne, 0))
Chris Lattner2188e402010-01-04 07:37:31 +00002856 return &I;
2857
2858 // Given the known and unknown bits, compute a range that the LHS could be
2859 // in. Compute the Min, Max and RHS values based on the known bits. For the
2860 // EQ and NE we use unsigned values.
2861 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
2862 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
2863 if (I.isSigned()) {
2864 ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2865 Op0Min, Op0Max);
2866 ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2867 Op1Min, Op1Max);
2868 } else {
2869 ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2870 Op0Min, Op0Max);
2871 ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2872 Op1Min, Op1Max);
2873 }
2874
2875 // If Min and Max are known to be the same, then SimplifyDemandedBits
2876 // figured out that the LHS is a constant. Just constant fold this now so
2877 // that code below can assume that Min != Max.
2878 if (!isa<Constant>(Op0) && Op0Min == Op0Max)
2879 return new ICmpInst(I.getPredicate(),
Nick Lewycky92db8e82011-03-06 03:36:19 +00002880 ConstantInt::get(Op0->getType(), Op0Min), Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00002881 if (!isa<Constant>(Op1) && Op1Min == Op1Max)
2882 return new ICmpInst(I.getPredicate(), Op0,
Nick Lewycky92db8e82011-03-06 03:36:19 +00002883 ConstantInt::get(Op1->getType(), Op1Min));
Chris Lattner2188e402010-01-04 07:37:31 +00002884
2885 // Based on the range information we know about the LHS, see if we can
Nick Lewycky6b4454192011-02-28 06:20:05 +00002886 // simplify this comparison. For example, (x&4) < 8 is always true.
Chris Lattner2188e402010-01-04 07:37:31 +00002887 switch (I.getPredicate()) {
2888 default: llvm_unreachable("Unknown icmp opcode!");
Chris Lattnerf7e89612010-11-21 06:44:42 +00002889 case ICmpInst::ICMP_EQ: {
Chris Lattner2188e402010-01-04 07:37:31 +00002890 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Nick Lewycky92db8e82011-03-06 03:36:19 +00002891 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Jim Grosbach129c52a2011-09-30 18:09:53 +00002892
Chris Lattnerf7e89612010-11-21 06:44:42 +00002893 // If all bits are known zero except for one, then we know at most one
2894 // bit is set. If the comparison is against zero, then this is a check
2895 // to see if *that* bit is set.
2896 APInt Op0KnownZeroInverted = ~Op0KnownZero;
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002897 if (~Op1KnownZero == 0) {
Chris Lattnerf7e89612010-11-21 06:44:42 +00002898 // If the LHS is an AND with the same constant, look through it.
Craig Topperf40110f2014-04-25 05:29:35 +00002899 Value *LHS = nullptr;
2900 ConstantInt *LHSC = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002901 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2902 LHSC->getValue() != Op0KnownZeroInverted)
2903 LHS = Op0;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002904
Chris Lattnerf7e89612010-11-21 06:44:42 +00002905 // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
Chris Lattnere5afa152010-11-23 02:42:04 +00002906 // then turn "((1 << x)&8) == 0" into "x != 3".
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002907 // or turn "((1 << x)&7) == 0" into "x > 2".
Craig Topperf40110f2014-04-25 05:29:35 +00002908 Value *X = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002909 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002910 APInt ValToCheck = Op0KnownZeroInverted;
2911 if (ValToCheck.isPowerOf2()) {
2912 unsigned CmpVal = ValToCheck.countTrailingZeros();
2913 return new ICmpInst(ICmpInst::ICMP_NE, X,
2914 ConstantInt::get(X->getType(), CmpVal));
2915 } else if ((++ValToCheck).isPowerOf2()) {
2916 unsigned CmpVal = ValToCheck.countTrailingZeros() - 1;
2917 return new ICmpInst(ICmpInst::ICMP_UGT, X,
2918 ConstantInt::get(X->getType(), CmpVal));
2919 }
Chris Lattnerf7e89612010-11-21 06:44:42 +00002920 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002921
Chris Lattnerf7e89612010-11-21 06:44:42 +00002922 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
Chris Lattnere5afa152010-11-23 02:42:04 +00002923 // then turn "((8 >>u x)&1) == 0" into "x != 3".
Chris Lattner98457102011-02-10 05:23:05 +00002924 const APInt *CI;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002925 if (Op0KnownZeroInverted == 1 &&
Chris Lattner98457102011-02-10 05:23:05 +00002926 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattnere5afa152010-11-23 02:42:04 +00002927 return new ICmpInst(ICmpInst::ICMP_NE, X,
Chris Lattner98457102011-02-10 05:23:05 +00002928 ConstantInt::get(X->getType(),
2929 CI->countTrailingZeros()));
Chris Lattnerf7e89612010-11-21 06:44:42 +00002930 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002931
Chris Lattner2188e402010-01-04 07:37:31 +00002932 break;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002933 }
2934 case ICmpInst::ICMP_NE: {
Chris Lattner2188e402010-01-04 07:37:31 +00002935 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Nick Lewycky92db8e82011-03-06 03:36:19 +00002936 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Jim Grosbach129c52a2011-09-30 18:09:53 +00002937
Chris Lattnerf7e89612010-11-21 06:44:42 +00002938 // If all bits are known zero except for one, then we know at most one
2939 // bit is set. If the comparison is against zero, then this is a check
2940 // to see if *that* bit is set.
2941 APInt Op0KnownZeroInverted = ~Op0KnownZero;
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002942 if (~Op1KnownZero == 0) {
Chris Lattnerf7e89612010-11-21 06:44:42 +00002943 // If the LHS is an AND with the same constant, look through it.
Craig Topperf40110f2014-04-25 05:29:35 +00002944 Value *LHS = nullptr;
2945 ConstantInt *LHSC = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002946 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2947 LHSC->getValue() != Op0KnownZeroInverted)
2948 LHS = Op0;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002949
Chris Lattnerf7e89612010-11-21 06:44:42 +00002950 // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
Chris Lattnere5afa152010-11-23 02:42:04 +00002951 // then turn "((1 << x)&8) != 0" into "x == 3".
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002952 // or turn "((1 << x)&7) != 0" into "x < 3".
Craig Topperf40110f2014-04-25 05:29:35 +00002953 Value *X = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002954 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002955 APInt ValToCheck = Op0KnownZeroInverted;
2956 if (ValToCheck.isPowerOf2()) {
2957 unsigned CmpVal = ValToCheck.countTrailingZeros();
2958 return new ICmpInst(ICmpInst::ICMP_EQ, X,
2959 ConstantInt::get(X->getType(), CmpVal));
2960 } else if ((++ValToCheck).isPowerOf2()) {
2961 unsigned CmpVal = ValToCheck.countTrailingZeros();
2962 return new ICmpInst(ICmpInst::ICMP_ULT, X,
2963 ConstantInt::get(X->getType(), CmpVal));
2964 }
Chris Lattnerf7e89612010-11-21 06:44:42 +00002965 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002966
Chris Lattnerf7e89612010-11-21 06:44:42 +00002967 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
Chris Lattnere5afa152010-11-23 02:42:04 +00002968 // then turn "((8 >>u x)&1) != 0" into "x == 3".
Chris Lattner98457102011-02-10 05:23:05 +00002969 const APInt *CI;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002970 if (Op0KnownZeroInverted == 1 &&
Chris Lattner98457102011-02-10 05:23:05 +00002971 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattnere5afa152010-11-23 02:42:04 +00002972 return new ICmpInst(ICmpInst::ICMP_EQ, X,
Chris Lattner98457102011-02-10 05:23:05 +00002973 ConstantInt::get(X->getType(),
2974 CI->countTrailingZeros()));
Chris Lattnerf7e89612010-11-21 06:44:42 +00002975 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002976
Chris Lattner2188e402010-01-04 07:37:31 +00002977 break;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002978 }
Chris Lattner2188e402010-01-04 07:37:31 +00002979 case ICmpInst::ICMP_ULT:
2980 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002981 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002982 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002983 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002984 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
2985 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2986 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2987 if (Op1Max == Op0Min+1) // A <u C -> A == C-1 if min(A)+1 == C
2988 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002989 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002990
2991 // (x <u 2147483648) -> (x >s -1) -> true if sign bit clear
2992 if (CI->isMinValue(true))
2993 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
2994 Constant::getAllOnesValue(Op0->getType()));
2995 }
2996 break;
2997 case ICmpInst::ICMP_UGT:
2998 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002999 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003000 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003001 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003002
3003 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
3004 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3005 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3006 if (Op1Min == Op0Max-1) // A >u C -> A == C+1 if max(a)-1 == C
3007 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00003008 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00003009
3010 // (x >u 2147483647) -> (x <s 0) -> true if sign bit set
3011 if (CI->isMaxValue(true))
3012 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
3013 Constant::getNullValue(Op0->getType()));
3014 }
3015 break;
3016 case ICmpInst::ICMP_SLT:
3017 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003018 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003019 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003020 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003021 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
3022 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3023 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3024 if (Op1Max == Op0Min+1) // A <s C -> A == C-1 if min(A)+1 == C
3025 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00003026 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00003027 }
3028 break;
3029 case ICmpInst::ICMP_SGT:
3030 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003031 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003032 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003033 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003034
3035 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
3036 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
3037 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
3038 if (Op1Min == Op0Max-1) // A >s C -> A == C+1 if max(A)-1 == C
3039 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00003040 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00003041 }
3042 break;
3043 case ICmpInst::ICMP_SGE:
3044 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
3045 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003046 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003047 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003048 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003049 break;
3050 case ICmpInst::ICMP_SLE:
3051 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
3052 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003053 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003054 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003055 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003056 break;
3057 case ICmpInst::ICMP_UGE:
3058 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
3059 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003060 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003061 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003062 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003063 break;
3064 case ICmpInst::ICMP_ULE:
3065 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
3066 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003067 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003068 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00003069 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00003070 break;
3071 }
3072
3073 // Turn a signed comparison into an unsigned one if both operands
3074 // are known to have the same sign.
3075 if (I.isSigned() &&
3076 ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) ||
3077 (Op0KnownOne.isNegative() && Op1KnownOne.isNegative())))
3078 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
3079 }
3080
3081 // Test if the ICmpInst instruction is used exclusively by a select as
3082 // part of a minimum or maximum operation. If so, refrain from doing
3083 // any other folding. This helps out other analyses which understand
3084 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
3085 // and CodeGen. And in this case, at least one of the comparison
3086 // operands has at least one user besides the compare (the select),
3087 // which would often largely negate the benefit of folding anyway.
3088 if (I.hasOneUse())
Chandler Carruthcdf47882014-03-09 03:16:01 +00003089 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
Chris Lattner2188e402010-01-04 07:37:31 +00003090 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
3091 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
Craig Topperf40110f2014-04-25 05:29:35 +00003092 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003093
3094 // See if we are doing a comparison between a constant and an instruction that
3095 // can be folded into the comparison.
3096 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00003097 // Since the RHS is a ConstantInt (CI), if the left hand side is an
3098 // instruction, see if that instruction also has constants so that the
3099 // instruction can be folded into the icmp
Chris Lattner2188e402010-01-04 07:37:31 +00003100 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3101 if (Instruction *Res = visitICmpInstWithInstAndIntCst(I, LHSI, CI))
3102 return Res;
3103 }
3104
3105 // Handle icmp with constant (but not simple integer constant) RHS
3106 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
3107 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3108 switch (LHSI->getOpcode()) {
3109 case Instruction::GetElementPtr:
3110 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
3111 if (RHSC->isNullValue() &&
3112 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
3113 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
3114 Constant::getNullValue(LHSI->getOperand(0)->getType()));
3115 break;
3116 case Instruction::PHI:
3117 // Only fold icmp into the PHI if the phi and icmp are in the same
3118 // block. If in the same block, we're encouraging jump threading. If
3119 // not, we are just pessimizing the code by making an i1 phi.
3120 if (LHSI->getParent() == I.getParent())
Chris Lattnerea7131a2011-01-16 05:14:26 +00003121 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner2188e402010-01-04 07:37:31 +00003122 return NV;
3123 break;
3124 case Instruction::Select: {
3125 // If either operand of the select is a constant, we can fold the
3126 // comparison into the select arms, which will cause one to be
3127 // constant folded and the select turned into a bitwise or.
Craig Topperf40110f2014-04-25 05:29:35 +00003128 Value *Op1 = nullptr, *Op2 = nullptr;
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003129 ConstantInt *CI = 0;
3130 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003131 Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003132 CI = dyn_cast<ConstantInt>(Op1);
3133 }
3134 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003135 Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003136 CI = dyn_cast<ConstantInt>(Op2);
3137 }
Chris Lattner2188e402010-01-04 07:37:31 +00003138
3139 // We only want to perform this transformation if it will not lead to
3140 // additional code. This is true if either both sides of the select
3141 // fold to a constant (in which case the icmp is replaced with a select
3142 // which will usually simplify) or this is the only user of the
3143 // select (in which case we are trading a select+icmp for a simpler
Gerolf Hoflehnerec6217c2014-11-21 23:36:44 +00003144 // select+icmp) or all uses of the select can be replaced based on
3145 // dominance information ("Global cases").
3146 bool Transform = false;
3147 if (Op1 && Op2)
3148 Transform = true;
3149 else if (Op1 || Op2) {
3150 // Local case
3151 if (LHSI->hasOneUse())
3152 Transform = true;
3153 // Global cases
3154 else if (CI && !CI->isZero())
3155 // When Op1 is constant try replacing select with second operand.
3156 // Otherwise Op2 is constant and try replacing select with first
3157 // operand.
3158 Transform = replacedSelectWithOperand(cast<SelectInst>(LHSI), &I,
3159 Op1 ? 2 : 1);
3160 }
3161 if (Transform) {
Chris Lattner2188e402010-01-04 07:37:31 +00003162 if (!Op1)
3163 Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1),
3164 RHSC, I.getName());
3165 if (!Op2)
3166 Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2),
3167 RHSC, I.getName());
3168 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
3169 }
3170 break;
3171 }
Chris Lattner2188e402010-01-04 07:37:31 +00003172 case Instruction::IntToPtr:
3173 // icmp pred inttoptr(X), null -> icmp pred X, 0
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003174 if (RHSC->isNullValue() &&
3175 DL.getIntPtrType(RHSC->getType()) == LHSI->getOperand(0)->getType())
Chris Lattner2188e402010-01-04 07:37:31 +00003176 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
3177 Constant::getNullValue(LHSI->getOperand(0)->getType()));
3178 break;
3179
3180 case Instruction::Load:
3181 // Try to optimize things like "A[i] > 4" to index computations.
3182 if (GetElementPtrInst *GEP =
3183 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3184 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3185 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3186 !cast<LoadInst>(LHSI)->isVolatile())
3187 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
3188 return Res;
3189 }
3190 break;
3191 }
3192 }
3193
3194 // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
3195 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
3196 if (Instruction *NI = FoldGEPICmp(GEP, Op1, I.getPredicate(), I))
3197 return NI;
3198 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
3199 if (Instruction *NI = FoldGEPICmp(GEP, Op0,
3200 ICmpInst::getSwappedPredicate(I.getPredicate()), I))
3201 return NI;
3202
3203 // Test to see if the operands of the icmp are casted versions of other
3204 // values. If the ptr->ptr cast can be stripped off both arguments, we do so
3205 // now.
3206 if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00003207 if (Op0->getType()->isPointerTy() &&
3208 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00003209 // We keep moving the cast from the left operand over to the right
3210 // operand, where it can often be eliminated completely.
3211 Op0 = CI->getOperand(0);
3212
3213 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
3214 // so eliminate it as well.
3215 if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
3216 Op1 = CI2->getOperand(0);
3217
3218 // If Op1 is a constant, we can fold the cast into the constant.
3219 if (Op0->getType() != Op1->getType()) {
3220 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
3221 Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
3222 } else {
3223 // Otherwise, cast the RHS right before the icmp
3224 Op1 = Builder->CreateBitCast(Op1, Op0->getType());
3225 }
3226 }
3227 return new ICmpInst(I.getPredicate(), Op0, Op1);
3228 }
3229 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003230
Chris Lattner2188e402010-01-04 07:37:31 +00003231 if (isa<CastInst>(Op0)) {
3232 // Handle the special case of: icmp (cast bool to X), <cst>
3233 // This comes up when you have code like
3234 // int X = A < B;
3235 // if (X) ...
3236 // For generality, we handle any zero-extension of any operand comparison
3237 // with a constant or another cast from the same type.
3238 if (isa<Constant>(Op1) || isa<CastInst>(Op1))
3239 if (Instruction *R = visitICmpInstWithCastAndCast(I))
3240 return R;
3241 }
Chris Lattner2188e402010-01-04 07:37:31 +00003242
Duncan Sandse5220012011-02-17 07:46:37 +00003243 // Special logic for binary operators.
3244 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
3245 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
3246 if (BO0 || BO1) {
3247 CmpInst::Predicate Pred = I.getPredicate();
3248 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
3249 if (BO0 && isa<OverflowingBinaryOperator>(BO0))
3250 NoOp0WrapProblem = ICmpInst::isEquality(Pred) ||
3251 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
3252 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
3253 if (BO1 && isa<OverflowingBinaryOperator>(BO1))
3254 NoOp1WrapProblem = ICmpInst::isEquality(Pred) ||
3255 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
3256 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
3257
3258 // Analyze the case when either Op0 or Op1 is an add instruction.
3259 // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null).
Craig Topperf40110f2014-04-25 05:29:35 +00003260 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
Duncan Sandse5220012011-02-17 07:46:37 +00003261 if (BO0 && BO0->getOpcode() == Instruction::Add)
3262 A = BO0->getOperand(0), B = BO0->getOperand(1);
3263 if (BO1 && BO1->getOpcode() == Instruction::Add)
3264 C = BO1->getOperand(0), D = BO1->getOperand(1);
3265
David Majnemer549f4f22014-11-01 09:09:51 +00003266 // icmp (X+cst) < 0 --> X < -cst
3267 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred) && match(Op1, m_Zero()))
3268 if (ConstantInt *RHSC = dyn_cast_or_null<ConstantInt>(B))
3269 if (!RHSC->isMinValue(/*isSigned=*/true))
3270 return new ICmpInst(Pred, A, ConstantExpr::getNeg(RHSC));
3271
Duncan Sandse5220012011-02-17 07:46:37 +00003272 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
3273 if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
3274 return new ICmpInst(Pred, A == Op1 ? B : A,
3275 Constant::getNullValue(Op1->getType()));
3276
3277 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
3278 if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
3279 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
3280 C == Op0 ? D : C);
3281
Duncan Sands84653b32011-02-18 16:25:37 +00003282 // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandse5220012011-02-17 07:46:37 +00003283 if (A && C && (A == C || A == D || B == C || B == D) &&
3284 NoOp0WrapProblem && NoOp1WrapProblem &&
3285 // Try not to increase register pressure.
3286 BO0->hasOneUse() && BO1->hasOneUse()) {
3287 // Determine Y and Z in the form icmp (X+Y), (X+Z).
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003288 Value *Y, *Z;
3289 if (A == C) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003290 // C + B == C + D -> B == D
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003291 Y = B;
3292 Z = D;
3293 } else if (A == D) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003294 // D + B == C + D -> B == C
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003295 Y = B;
3296 Z = C;
3297 } else if (B == C) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003298 // A + C == C + D -> A == D
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003299 Y = A;
3300 Z = D;
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003301 } else {
3302 assert(B == D);
3303 // A + D == C + D -> A == C
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003304 Y = A;
3305 Z = C;
3306 }
Duncan Sandse5220012011-02-17 07:46:37 +00003307 return new ICmpInst(Pred, Y, Z);
3308 }
3309
David Majnemerb81cd632013-04-11 20:05:46 +00003310 // icmp slt (X + -1), Y -> icmp sle X, Y
3311 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
3312 match(B, m_AllOnes()))
3313 return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
3314
3315 // icmp sge (X + -1), Y -> icmp sgt X, Y
3316 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
3317 match(B, m_AllOnes()))
3318 return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
3319
3320 // icmp sle (X + 1), Y -> icmp slt X, Y
3321 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE &&
3322 match(B, m_One()))
3323 return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
3324
3325 // icmp sgt (X + 1), Y -> icmp sge X, Y
3326 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT &&
3327 match(B, m_One()))
3328 return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
3329
3330 // if C1 has greater magnitude than C2:
3331 // icmp (X + C1), (Y + C2) -> icmp (X + C3), Y
3332 // s.t. C3 = C1 - C2
3333 //
3334 // if C2 has greater magnitude than C1:
3335 // icmp (X + C1), (Y + C2) -> icmp X, (Y + C3)
3336 // s.t. C3 = C2 - C1
3337 if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
3338 (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
3339 if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
3340 if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
3341 const APInt &AP1 = C1->getValue();
3342 const APInt &AP2 = C2->getValue();
3343 if (AP1.isNegative() == AP2.isNegative()) {
3344 APInt AP1Abs = C1->getValue().abs();
3345 APInt AP2Abs = C2->getValue().abs();
3346 if (AP1Abs.uge(AP2Abs)) {
3347 ConstantInt *C3 = Builder->getInt(AP1 - AP2);
3348 Value *NewAdd = Builder->CreateNSWAdd(A, C3);
3349 return new ICmpInst(Pred, NewAdd, C);
3350 } else {
3351 ConstantInt *C3 = Builder->getInt(AP2 - AP1);
3352 Value *NewAdd = Builder->CreateNSWAdd(C, C3);
3353 return new ICmpInst(Pred, A, NewAdd);
3354 }
3355 }
3356 }
3357
3358
Duncan Sandse5220012011-02-17 07:46:37 +00003359 // Analyze the case when either Op0 or Op1 is a sub instruction.
3360 // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null).
Craig Topperf40110f2014-04-25 05:29:35 +00003361 A = nullptr; B = nullptr; C = nullptr; D = nullptr;
Duncan Sandse5220012011-02-17 07:46:37 +00003362 if (BO0 && BO0->getOpcode() == Instruction::Sub)
3363 A = BO0->getOperand(0), B = BO0->getOperand(1);
3364 if (BO1 && BO1->getOpcode() == Instruction::Sub)
3365 C = BO1->getOperand(0), D = BO1->getOperand(1);
3366
Duncan Sands84653b32011-02-18 16:25:37 +00003367 // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
3368 if (A == Op1 && NoOp0WrapProblem)
3369 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
3370
3371 // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
3372 if (C == Op0 && NoOp1WrapProblem)
3373 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
3374
3375 // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandse5220012011-02-17 07:46:37 +00003376 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
3377 // Try not to increase register pressure.
3378 BO0->hasOneUse() && BO1->hasOneUse())
3379 return new ICmpInst(Pred, A, C);
3380
Duncan Sands84653b32011-02-18 16:25:37 +00003381 // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
3382 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
3383 // Try not to increase register pressure.
3384 BO0->hasOneUse() && BO1->hasOneUse())
3385 return new ICmpInst(Pred, D, B);
3386
David Majnemer186c9422014-05-15 00:02:20 +00003387 // icmp (0-X) < cst --> x > -cst
3388 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) {
3389 Value *X;
3390 if (match(BO0, m_Neg(m_Value(X))))
3391 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
3392 if (!RHSC->isMinValue(/*isSigned=*/true))
3393 return new ICmpInst(I.getSwappedPredicate(), X,
3394 ConstantExpr::getNeg(RHSC));
3395 }
3396
Craig Topperf40110f2014-04-25 05:29:35 +00003397 BinaryOperator *SRem = nullptr;
Nick Lewyckyafc80982011-03-08 06:29:47 +00003398 // icmp (srem X, Y), Y
Nick Lewycky25cc3382011-03-05 04:28:48 +00003399 if (BO0 && BO0->getOpcode() == Instruction::SRem &&
3400 Op1 == BO0->getOperand(1))
3401 SRem = BO0;
Nick Lewyckyafc80982011-03-08 06:29:47 +00003402 // icmp Y, (srem X, Y)
Nick Lewycky25cc3382011-03-05 04:28:48 +00003403 else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
3404 Op0 == BO1->getOperand(1))
3405 SRem = BO1;
3406 if (SRem) {
3407 // We don't check hasOneUse to avoid increasing register pressure because
3408 // the value we use is the same value this instruction was already using.
3409 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
3410 default: break;
3411 case ICmpInst::ICMP_EQ:
Nick Lewycky92db8e82011-03-06 03:36:19 +00003412 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Nick Lewycky25cc3382011-03-05 04:28:48 +00003413 case ICmpInst::ICMP_NE:
Nick Lewycky92db8e82011-03-06 03:36:19 +00003414 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Nick Lewycky25cc3382011-03-05 04:28:48 +00003415 case ICmpInst::ICMP_SGT:
3416 case ICmpInst::ICMP_SGE:
3417 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
3418 Constant::getAllOnesValue(SRem->getType()));
3419 case ICmpInst::ICMP_SLT:
3420 case ICmpInst::ICMP_SLE:
3421 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
3422 Constant::getNullValue(SRem->getType()));
3423 }
3424 }
3425
Duncan Sandse5220012011-02-17 07:46:37 +00003426 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() &&
3427 BO0->hasOneUse() && BO1->hasOneUse() &&
3428 BO0->getOperand(1) == BO1->getOperand(1)) {
3429 switch (BO0->getOpcode()) {
3430 default: break;
3431 case Instruction::Add:
3432 case Instruction::Sub:
3433 case Instruction::Xor:
3434 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
3435 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3436 BO1->getOperand(0));
3437 // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b
3438 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
3439 if (CI->getValue().isSignBit()) {
3440 ICmpInst::Predicate Pred = I.isSigned()
3441 ? I.getUnsignedPredicate()
3442 : I.getSignedPredicate();
3443 return new ICmpInst(Pred, BO0->getOperand(0),
3444 BO1->getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +00003445 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003446
Chris Lattnerb1a15122011-07-15 06:08:15 +00003447 if (CI->isMaxValue(true)) {
Duncan Sandse5220012011-02-17 07:46:37 +00003448 ICmpInst::Predicate Pred = I.isSigned()
3449 ? I.getUnsignedPredicate()
3450 : I.getSignedPredicate();
3451 Pred = I.getSwappedPredicate(Pred);
3452 return new ICmpInst(Pred, BO0->getOperand(0),
3453 BO1->getOperand(0));
3454 }
Chris Lattner2188e402010-01-04 07:37:31 +00003455 }
Duncan Sandse5220012011-02-17 07:46:37 +00003456 break;
3457 case Instruction::Mul:
3458 if (!I.isEquality())
3459 break;
3460
3461 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
3462 // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask
3463 // Mask = -1 >> count-trailing-zeros(Cst).
3464 if (!CI->isZero() && !CI->isOne()) {
3465 const APInt &AP = CI->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003466 ConstantInt *Mask = ConstantInt::get(I.getContext(),
Duncan Sandse5220012011-02-17 07:46:37 +00003467 APInt::getLowBitsSet(AP.getBitWidth(),
3468 AP.getBitWidth() -
3469 AP.countTrailingZeros()));
3470 Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask);
3471 Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask);
3472 return new ICmpInst(I.getPredicate(), And1, And2);
3473 }
3474 }
3475 break;
Nick Lewycky9719a712011-03-05 05:19:11 +00003476 case Instruction::UDiv:
3477 case Instruction::LShr:
3478 if (I.isSigned())
3479 break;
3480 // fall-through
3481 case Instruction::SDiv:
3482 case Instruction::AShr:
Eli Friedman8a20e662011-05-05 21:59:18 +00003483 if (!BO0->isExact() || !BO1->isExact())
Nick Lewycky9719a712011-03-05 05:19:11 +00003484 break;
3485 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3486 BO1->getOperand(0));
3487 case Instruction::Shl: {
3488 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
3489 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
3490 if (!NUW && !NSW)
3491 break;
3492 if (!NSW && I.isSigned())
3493 break;
3494 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3495 BO1->getOperand(0));
3496 }
Chris Lattner2188e402010-01-04 07:37:31 +00003497 }
3498 }
Sanjoy Dasc86c1622015-08-21 22:22:37 +00003499
3500 if (BO0) {
3501 // Transform A & (L - 1) `ult` L --> L != 0
3502 auto LSubOne = m_Add(m_Specific(Op1), m_AllOnes());
3503 auto BitwiseAnd =
3504 m_CombineOr(m_And(m_Value(), LSubOne), m_And(LSubOne, m_Value()));
3505
3506 if (match(BO0, BitwiseAnd) && I.getPredicate() == ICmpInst::ICMP_ULT) {
3507 auto *Zero = Constant::getNullValue(BO0->getType());
3508 return new ICmpInst(ICmpInst::ICMP_NE, Op1, Zero);
3509 }
3510 }
Chris Lattner2188e402010-01-04 07:37:31 +00003511 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003512
Chris Lattner2188e402010-01-04 07:37:31 +00003513 { Value *A, *B;
David Majnemer1a08acc2013-04-12 17:25:07 +00003514 // Transform (A & ~B) == 0 --> (A & B) != 0
3515 // and (A & ~B) != 0 --> (A & B) == 0
3516 // if A is a power of 2.
3517 if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
Chandler Carruth66b31302015-01-04 12:03:27 +00003518 match(Op1, m_Zero()) &&
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003519 isKnownToBeAPowerOfTwo(A, DL, false, 0, AC, &I, DT) && I.isEquality())
David Majnemer1a08acc2013-04-12 17:25:07 +00003520 return new ICmpInst(I.getInversePredicate(),
3521 Builder->CreateAnd(A, B),
3522 Op1);
3523
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00003524 // ~x < ~y --> y < x
3525 // ~x < cst --> ~cst < x
3526 if (match(Op0, m_Not(m_Value(A)))) {
3527 if (match(Op1, m_Not(m_Value(B))))
3528 return new ICmpInst(I.getPredicate(), B, A);
Chris Lattner497459d2011-01-15 05:42:47 +00003529 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00003530 return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A);
3531 }
Chris Lattner5e0c0c72010-12-19 19:37:52 +00003532
Sanjoy Dasb6c59142015-04-10 21:07:09 +00003533 Instruction *AddI = nullptr;
3534 if (match(&I, m_UAddWithOverflow(m_Value(A), m_Value(B),
3535 m_Instruction(AddI))) &&
3536 isa<IntegerType>(A->getType())) {
3537 Value *Result;
3538 Constant *Overflow;
3539 if (OptimizeOverflowCheck(OCF_UNSIGNED_ADD, A, B, *AddI, Result,
3540 Overflow)) {
3541 ReplaceInstUsesWith(*AddI, Result);
3542 return ReplaceInstUsesWith(I, Overflow);
3543 }
3544 }
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003545
3546 // (zext a) * (zext b) --> llvm.umul.with.overflow.
3547 if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
3548 if (Instruction *R = ProcessUMulZExtIdiom(I, Op0, Op1, *this))
3549 return R;
3550 }
3551 if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
3552 if (Instruction *R = ProcessUMulZExtIdiom(I, Op1, Op0, *this))
3553 return R;
3554 }
Chris Lattner2188e402010-01-04 07:37:31 +00003555 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003556
Chris Lattner2188e402010-01-04 07:37:31 +00003557 if (I.isEquality()) {
3558 Value *A, *B, *C, *D;
Duncan Sands84653b32011-02-18 16:25:37 +00003559
Chris Lattner2188e402010-01-04 07:37:31 +00003560 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
3561 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0
3562 Value *OtherVal = A == Op1 ? B : A;
3563 return new ICmpInst(I.getPredicate(), OtherVal,
3564 Constant::getNullValue(A->getType()));
3565 }
3566
3567 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
3568 // A^c1 == C^c2 --> A == C^(c1^c2)
3569 ConstantInt *C1, *C2;
3570 if (match(B, m_ConstantInt(C1)) &&
3571 match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) {
Jakub Staszakbddea112013-06-06 20:18:46 +00003572 Constant *NC = Builder->getInt(C1->getValue() ^ C2->getValue());
Benjamin Kramer547b6c52011-09-27 20:39:19 +00003573 Value *Xor = Builder->CreateXor(C, NC);
Chris Lattner2188e402010-01-04 07:37:31 +00003574 return new ICmpInst(I.getPredicate(), A, Xor);
3575 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003576
Chris Lattner2188e402010-01-04 07:37:31 +00003577 // A^B == A^D -> B == D
3578 if (A == C) return new ICmpInst(I.getPredicate(), B, D);
3579 if (A == D) return new ICmpInst(I.getPredicate(), B, C);
3580 if (B == C) return new ICmpInst(I.getPredicate(), A, D);
3581 if (B == D) return new ICmpInst(I.getPredicate(), A, C);
3582 }
3583 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003584
Chris Lattner2188e402010-01-04 07:37:31 +00003585 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
3586 (A == Op0 || B == Op0)) {
3587 // A == (A^B) -> B == 0
3588 Value *OtherVal = A == Op0 ? B : A;
3589 return new ICmpInst(I.getPredicate(), OtherVal,
3590 Constant::getNullValue(A->getType()));
3591 }
3592
Chris Lattner2188e402010-01-04 07:37:31 +00003593 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
Jim Grosbach129c52a2011-09-30 18:09:53 +00003594 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
Chris Lattner31b106d2011-04-26 20:02:45 +00003595 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
Craig Topperf40110f2014-04-25 05:29:35 +00003596 Value *X = nullptr, *Y = nullptr, *Z = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003597
Chris Lattner2188e402010-01-04 07:37:31 +00003598 if (A == C) {
3599 X = B; Y = D; Z = A;
3600 } else if (A == D) {
3601 X = B; Y = C; Z = A;
3602 } else if (B == C) {
3603 X = A; Y = D; Z = B;
3604 } else if (B == D) {
3605 X = A; Y = C; Z = B;
3606 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003607
Chris Lattner2188e402010-01-04 07:37:31 +00003608 if (X) { // Build (X^Y) & Z
Benjamin Kramer547b6c52011-09-27 20:39:19 +00003609 Op1 = Builder->CreateXor(X, Y);
3610 Op1 = Builder->CreateAnd(Op1, Z);
Chris Lattner2188e402010-01-04 07:37:31 +00003611 I.setOperand(0, Op1);
3612 I.setOperand(1, Constant::getNullValue(Op1->getType()));
3613 return &I;
3614 }
3615 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003616
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00003617 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
Benjamin Kramer21501452012-06-11 08:01:25 +00003618 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B)
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00003619 ConstantInt *Cst1;
Benjamin Kramer21501452012-06-11 08:01:25 +00003620 if ((Op0->hasOneUse() &&
3621 match(Op0, m_ZExt(m_Value(A))) &&
3622 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
3623 (Op1->hasOneUse() &&
3624 match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
3625 match(Op1, m_ZExt(m_Value(A))))) {
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00003626 APInt Pow2 = Cst1->getValue() + 1;
3627 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
3628 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
3629 return new ICmpInst(I.getPredicate(), A,
3630 Builder->CreateTrunc(B, A->getType()));
3631 }
3632
Benjamin Kramer03f3e242013-11-16 16:00:48 +00003633 // (A >> C) == (B >> C) --> (A^B) u< (1 << C)
3634 // For lshr and ashr pairs.
3635 if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) &&
3636 match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) ||
3637 (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) &&
3638 match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) {
3639 unsigned TypeBits = Cst1->getBitWidth();
3640 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
3641 if (ShAmt < TypeBits && ShAmt != 0) {
3642 ICmpInst::Predicate Pred = I.getPredicate() == ICmpInst::ICMP_NE
3643 ? ICmpInst::ICMP_UGE
3644 : ICmpInst::ICMP_ULT;
3645 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
3646 APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt);
3647 return new ICmpInst(Pred, Xor, Builder->getInt(CmpVal));
3648 }
3649 }
3650
Benjamin Kramer7fa8c432015-03-26 17:12:06 +00003651 // (A << C) == (B << C) --> ((A^B) & (~0U >> C)) == 0
3652 if (match(Op0, m_OneUse(m_Shl(m_Value(A), m_ConstantInt(Cst1)))) &&
3653 match(Op1, m_OneUse(m_Shl(m_Value(B), m_Specific(Cst1))))) {
3654 unsigned TypeBits = Cst1->getBitWidth();
3655 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
3656 if (ShAmt < TypeBits && ShAmt != 0) {
3657 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
3658 APInt AndVal = APInt::getLowBitsSet(TypeBits, TypeBits - ShAmt);
3659 Value *And = Builder->CreateAnd(Xor, Builder->getInt(AndVal),
3660 I.getName() + ".mask");
3661 return new ICmpInst(I.getPredicate(), And,
3662 Constant::getNullValue(Cst1->getType()));
3663 }
3664 }
3665
Chris Lattner1b06c712011-04-26 20:18:20 +00003666 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
3667 // "icmp (and X, mask), cst"
3668 uint64_t ShAmt = 0;
Chris Lattner1b06c712011-04-26 20:18:20 +00003669 if (Op0->hasOneUse() &&
3670 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A),
3671 m_ConstantInt(ShAmt))))) &&
3672 match(Op1, m_ConstantInt(Cst1)) &&
3673 // Only do this when A has multiple uses. This is most important to do
3674 // when it exposes other optimizations.
3675 !A->hasOneUse()) {
3676 unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003677
Chris Lattner1b06c712011-04-26 20:18:20 +00003678 if (ShAmt < ASize) {
3679 APInt MaskV =
3680 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
3681 MaskV <<= ShAmt;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003682
Chris Lattner1b06c712011-04-26 20:18:20 +00003683 APInt CmpV = Cst1->getValue().zext(ASize);
3684 CmpV <<= ShAmt;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003685
Chris Lattner1b06c712011-04-26 20:18:20 +00003686 Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV));
3687 return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV));
3688 }
3689 }
Chris Lattner2188e402010-01-04 07:37:31 +00003690 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003691
David Majnemerc1eca5a2014-11-06 23:23:30 +00003692 // The 'cmpxchg' instruction returns an aggregate containing the old value and
3693 // an i1 which indicates whether or not we successfully did the swap.
3694 //
3695 // Replace comparisons between the old value and the expected value with the
3696 // indicator that 'cmpxchg' returns.
3697 //
3698 // N.B. This transform is only valid when the 'cmpxchg' is not permitted to
3699 // spuriously fail. In those cases, the old value may equal the expected
3700 // value but it is possible for the swap to not occur.
3701 if (I.getPredicate() == ICmpInst::ICMP_EQ)
3702 if (auto *EVI = dyn_cast<ExtractValueInst>(Op0))
3703 if (auto *ACXI = dyn_cast<AtomicCmpXchgInst>(EVI->getAggregateOperand()))
3704 if (EVI->getIndices()[0] == 0 && ACXI->getCompareOperand() == Op1 &&
3705 !ACXI->isWeak())
3706 return ExtractValueInst::Create(ACXI, 1);
3707
Chris Lattner2188e402010-01-04 07:37:31 +00003708 {
3709 Value *X; ConstantInt *Cst;
3710 // icmp X+Cst, X
3711 if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X)
Benjamin Kramer0e2d1622013-09-20 22:12:42 +00003712 return FoldICmpAddOpCst(I, X, Cst, I.getPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00003713
3714 // icmp X, X+Cst
3715 if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X)
Benjamin Kramer0e2d1622013-09-20 22:12:42 +00003716 return FoldICmpAddOpCst(I, X, Cst, I.getSwappedPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00003717 }
Craig Topperf40110f2014-04-25 05:29:35 +00003718 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003719}
3720
Chris Lattner2188e402010-01-04 07:37:31 +00003721/// FoldFCmp_IntToFP_Cst - Fold fcmp ([us]itofp x, cst) if possible.
Chris Lattner2188e402010-01-04 07:37:31 +00003722Instruction *InstCombiner::FoldFCmp_IntToFP_Cst(FCmpInst &I,
3723 Instruction *LHSI,
3724 Constant *RHSC) {
Craig Topperf40110f2014-04-25 05:29:35 +00003725 if (!isa<ConstantFP>(RHSC)) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003726 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003727
Chris Lattner2188e402010-01-04 07:37:31 +00003728 // Get the width of the mantissa. We don't want to hack on conversions that
3729 // might lose information from the integer, e.g. "i64 -> float"
3730 int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
Craig Topperf40110f2014-04-25 05:29:35 +00003731 if (MantissaWidth == -1) return nullptr; // Unknown.
Jim Grosbach129c52a2011-09-30 18:09:53 +00003732
Matt Arsenault55e73122015-01-06 15:50:59 +00003733 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
3734
Chris Lattner2188e402010-01-04 07:37:31 +00003735 // Check to see that the input is converted from an integer type that is small
3736 // enough that preserves all bits. TODO: check here for "known" sign bits.
3737 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
Matt Arsenault55e73122015-01-06 15:50:59 +00003738 unsigned InputSize = IntTy->getScalarSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003739
Chris Lattner2188e402010-01-04 07:37:31 +00003740 // If this is a uitofp instruction, we need an extra bit to hold the sign.
3741 bool LHSUnsigned = isa<UIToFPInst>(LHSI);
3742 if (LHSUnsigned)
3743 ++InputSize;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003744
Matt Arsenault55e73122015-01-06 15:50:59 +00003745 if (I.isEquality()) {
3746 FCmpInst::Predicate P = I.getPredicate();
3747 bool IsExact = false;
3748 APSInt RHSCvt(IntTy->getBitWidth(), LHSUnsigned);
3749 RHS.convertToInteger(RHSCvt, APFloat::rmNearestTiesToEven, &IsExact);
3750
3751 // If the floating point constant isn't an integer value, we know if we will
3752 // ever compare equal / not equal to it.
3753 if (!IsExact) {
3754 // TODO: Can never be -0.0 and other non-representable values
3755 APFloat RHSRoundInt(RHS);
3756 RHSRoundInt.roundToIntegral(APFloat::rmNearestTiesToEven);
3757 if (RHS.compare(RHSRoundInt) != APFloat::cmpEqual) {
3758 if (P == FCmpInst::FCMP_OEQ || P == FCmpInst::FCMP_UEQ)
3759 return ReplaceInstUsesWith(I, Builder->getFalse());
3760
3761 assert(P == FCmpInst::FCMP_ONE || P == FCmpInst::FCMP_UNE);
3762 return ReplaceInstUsesWith(I, Builder->getTrue());
3763 }
3764 }
3765
3766 // TODO: If the constant is exactly representable, is it always OK to do
3767 // equality compares as integer?
3768 }
3769
3770 // Comparisons with zero are a special case where we know we won't lose
3771 // information.
3772 bool IsCmpZero = RHS.isPosZero();
3773
Chris Lattner2188e402010-01-04 07:37:31 +00003774 // If the conversion would lose info, don't hack on this.
Matt Arsenault55e73122015-01-06 15:50:59 +00003775 if ((int)InputSize > MantissaWidth && !IsCmpZero)
Craig Topperf40110f2014-04-25 05:29:35 +00003776 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003777
Chris Lattner2188e402010-01-04 07:37:31 +00003778 // Otherwise, we can potentially simplify the comparison. We know that it
3779 // will always come through as an integer value and we know the constant is
3780 // not a NAN (it would have been previously simplified).
3781 assert(!RHS.isNaN() && "NaN comparison not already folded!");
Jim Grosbach129c52a2011-09-30 18:09:53 +00003782
Chris Lattner2188e402010-01-04 07:37:31 +00003783 ICmpInst::Predicate Pred;
3784 switch (I.getPredicate()) {
3785 default: llvm_unreachable("Unexpected predicate!");
3786 case FCmpInst::FCMP_UEQ:
3787 case FCmpInst::FCMP_OEQ:
3788 Pred = ICmpInst::ICMP_EQ;
3789 break;
3790 case FCmpInst::FCMP_UGT:
3791 case FCmpInst::FCMP_OGT:
3792 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
3793 break;
3794 case FCmpInst::FCMP_UGE:
3795 case FCmpInst::FCMP_OGE:
3796 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
3797 break;
3798 case FCmpInst::FCMP_ULT:
3799 case FCmpInst::FCMP_OLT:
3800 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
3801 break;
3802 case FCmpInst::FCMP_ULE:
3803 case FCmpInst::FCMP_OLE:
3804 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
3805 break;
3806 case FCmpInst::FCMP_UNE:
3807 case FCmpInst::FCMP_ONE:
3808 Pred = ICmpInst::ICMP_NE;
3809 break;
3810 case FCmpInst::FCMP_ORD:
Jakub Staszakbddea112013-06-06 20:18:46 +00003811 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003812 case FCmpInst::FCMP_UNO:
Jakub Staszakbddea112013-06-06 20:18:46 +00003813 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003814 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003815
Chris Lattner2188e402010-01-04 07:37:31 +00003816 // Now we know that the APFloat is a normal number, zero or inf.
Jim Grosbach129c52a2011-09-30 18:09:53 +00003817
Chris Lattner2188e402010-01-04 07:37:31 +00003818 // See if the FP constant is too large for the integer. For example,
3819 // comparing an i8 to 300.0.
3820 unsigned IntWidth = IntTy->getScalarSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003821
Chris Lattner2188e402010-01-04 07:37:31 +00003822 if (!LHSUnsigned) {
3823 // If the RHS value is > SignedMax, fold the comparison. This handles +INF
3824 // and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00003825 APFloat SMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00003826 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
3827 APFloat::rmNearestTiesToEven);
3828 if (SMax.compare(RHS) == APFloat::cmpLessThan) { // smax < 13123.0
3829 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT ||
3830 Pred == ICmpInst::ICMP_SLE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003831 return ReplaceInstUsesWith(I, Builder->getTrue());
3832 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003833 }
3834 } else {
3835 // If the RHS value is > UnsignedMax, fold the comparison. This handles
3836 // +INF and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00003837 APFloat UMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00003838 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
3839 APFloat::rmNearestTiesToEven);
3840 if (UMax.compare(RHS) == APFloat::cmpLessThan) { // umax < 13123.0
3841 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT ||
3842 Pred == ICmpInst::ICMP_ULE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003843 return ReplaceInstUsesWith(I, Builder->getTrue());
3844 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003845 }
3846 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003847
Chris Lattner2188e402010-01-04 07:37:31 +00003848 if (!LHSUnsigned) {
3849 // See if the RHS value is < SignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00003850 APFloat SMin(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00003851 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
3852 APFloat::rmNearestTiesToEven);
3853 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
3854 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
3855 Pred == ICmpInst::ICMP_SGE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003856 return ReplaceInstUsesWith(I, Builder->getTrue());
3857 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003858 }
Devang Patel698452b2012-02-13 23:05:18 +00003859 } else {
3860 // See if the RHS value is < UnsignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00003861 APFloat SMin(RHS.getSemantics());
Devang Patel698452b2012-02-13 23:05:18 +00003862 SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
3863 APFloat::rmNearestTiesToEven);
3864 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
3865 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
3866 Pred == ICmpInst::ICMP_UGE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003867 return ReplaceInstUsesWith(I, Builder->getTrue());
3868 return ReplaceInstUsesWith(I, Builder->getFalse());
Devang Patel698452b2012-02-13 23:05:18 +00003869 }
Chris Lattner2188e402010-01-04 07:37:31 +00003870 }
3871
3872 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
3873 // [0, UMAX], but it may still be fractional. See if it is fractional by
3874 // casting the FP value to the integer value and back, checking for equality.
3875 // Don't do this for zero, because -0.0 is not fractional.
3876 Constant *RHSInt = LHSUnsigned
3877 ? ConstantExpr::getFPToUI(RHSC, IntTy)
3878 : ConstantExpr::getFPToSI(RHSC, IntTy);
3879 if (!RHS.isZero()) {
3880 bool Equal = LHSUnsigned
3881 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
3882 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
3883 if (!Equal) {
3884 // If we had a comparison against a fractional value, we have to adjust
3885 // the compare predicate and sometimes the value. RHSC is rounded towards
3886 // zero at this point.
3887 switch (Pred) {
3888 default: llvm_unreachable("Unexpected integer comparison!");
3889 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true
Jakub Staszakbddea112013-06-06 20:18:46 +00003890 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003891 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false
Jakub Staszakbddea112013-06-06 20:18:46 +00003892 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003893 case ICmpInst::ICMP_ULE:
3894 // (float)int <= 4.4 --> int <= 4
3895 // (float)int <= -4.4 --> false
3896 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003897 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003898 break;
3899 case ICmpInst::ICMP_SLE:
3900 // (float)int <= 4.4 --> int <= 4
3901 // (float)int <= -4.4 --> int < -4
3902 if (RHS.isNegative())
3903 Pred = ICmpInst::ICMP_SLT;
3904 break;
3905 case ICmpInst::ICMP_ULT:
3906 // (float)int < -4.4 --> false
3907 // (float)int < 4.4 --> int <= 4
3908 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003909 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003910 Pred = ICmpInst::ICMP_ULE;
3911 break;
3912 case ICmpInst::ICMP_SLT:
3913 // (float)int < -4.4 --> int < -4
3914 // (float)int < 4.4 --> int <= 4
3915 if (!RHS.isNegative())
3916 Pred = ICmpInst::ICMP_SLE;
3917 break;
3918 case ICmpInst::ICMP_UGT:
3919 // (float)int > 4.4 --> int > 4
3920 // (float)int > -4.4 --> true
3921 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003922 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003923 break;
3924 case ICmpInst::ICMP_SGT:
3925 // (float)int > 4.4 --> int > 4
3926 // (float)int > -4.4 --> int >= -4
3927 if (RHS.isNegative())
3928 Pred = ICmpInst::ICMP_SGE;
3929 break;
3930 case ICmpInst::ICMP_UGE:
3931 // (float)int >= -4.4 --> true
3932 // (float)int >= 4.4 --> int > 4
Bob Wilson61f3ad52012-08-07 22:35:16 +00003933 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003934 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003935 Pred = ICmpInst::ICMP_UGT;
3936 break;
3937 case ICmpInst::ICMP_SGE:
3938 // (float)int >= -4.4 --> int >= -4
3939 // (float)int >= 4.4 --> int > 4
3940 if (!RHS.isNegative())
3941 Pred = ICmpInst::ICMP_SGT;
3942 break;
3943 }
3944 }
3945 }
3946
3947 // Lower this FP comparison into an appropriate integer version of the
3948 // comparison.
3949 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
3950}
3951
3952Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
3953 bool Changed = false;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003954
Chris Lattner2188e402010-01-04 07:37:31 +00003955 /// Orders the operands of the compare so that they are listed from most
3956 /// complex to least complex. This puts constants before unary operators,
3957 /// before binary operators.
3958 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
3959 I.swapOperands();
3960 Changed = true;
3961 }
3962
3963 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00003964
Benjamin Kramerf4ebfa32015-07-10 14:02:02 +00003965 if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1,
3966 I.getFastMathFlags(), DL, TLI, DT, AC, &I))
Chris Lattner2188e402010-01-04 07:37:31 +00003967 return ReplaceInstUsesWith(I, V);
3968
3969 // Simplify 'fcmp pred X, X'
3970 if (Op0 == Op1) {
3971 switch (I.getPredicate()) {
3972 default: llvm_unreachable("Unknown predicate!");
3973 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y)
3974 case FCmpInst::FCMP_ULT: // True if unordered or less than
3975 case FCmpInst::FCMP_UGT: // True if unordered or greater than
3976 case FCmpInst::FCMP_UNE: // True if unordered or not equal
3977 // Canonicalize these to be 'fcmp uno %X, 0.0'.
3978 I.setPredicate(FCmpInst::FCMP_UNO);
3979 I.setOperand(1, Constant::getNullValue(Op0->getType()));
3980 return &I;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003981
Chris Lattner2188e402010-01-04 07:37:31 +00003982 case FCmpInst::FCMP_ORD: // True if ordered (no nans)
3983 case FCmpInst::FCMP_OEQ: // True if ordered and equal
3984 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal
3985 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal
3986 // Canonicalize these to be 'fcmp ord %X, 0.0'.
3987 I.setPredicate(FCmpInst::FCMP_ORD);
3988 I.setOperand(1, Constant::getNullValue(Op0->getType()));
3989 return &I;
3990 }
3991 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003992
James Molloy2b21a7c2015-05-20 18:41:25 +00003993 // Test if the FCmpInst instruction is used exclusively by a select as
3994 // part of a minimum or maximum operation. If so, refrain from doing
3995 // any other folding. This helps out other analyses which understand
3996 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
3997 // and CodeGen. And in this case, at least one of the comparison
3998 // operands has at least one user besides the compare (the select),
3999 // which would often largely negate the benefit of folding anyway.
4000 if (I.hasOneUse())
4001 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
4002 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
4003 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
4004 return nullptr;
4005
Chris Lattner2188e402010-01-04 07:37:31 +00004006 // Handle fcmp with constant RHS
4007 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
4008 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
4009 switch (LHSI->getOpcode()) {
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004010 case Instruction::FPExt: {
4011 // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
4012 FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
4013 ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
4014 if (!RHSF)
4015 break;
4016
4017 const fltSemantics *Sem;
4018 // FIXME: This shouldn't be here.
Dan Gohman518cda42011-12-17 00:04:22 +00004019 if (LHSExt->getSrcTy()->isHalfTy())
4020 Sem = &APFloat::IEEEhalf;
4021 else if (LHSExt->getSrcTy()->isFloatTy())
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004022 Sem = &APFloat::IEEEsingle;
4023 else if (LHSExt->getSrcTy()->isDoubleTy())
4024 Sem = &APFloat::IEEEdouble;
4025 else if (LHSExt->getSrcTy()->isFP128Ty())
4026 Sem = &APFloat::IEEEquad;
4027 else if (LHSExt->getSrcTy()->isX86_FP80Ty())
4028 Sem = &APFloat::x87DoubleExtended;
Ulrich Weigand6a9bb512012-10-30 12:33:18 +00004029 else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
4030 Sem = &APFloat::PPCDoubleDouble;
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004031 else
4032 break;
4033
4034 bool Lossy;
4035 APFloat F = RHSF->getValueAPF();
4036 F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
4037
Jim Grosbach24ff8342011-09-30 18:45:50 +00004038 // Avoid lossy conversions and denormals. Zero is a special case
4039 // that's OK to convert.
Jim Grosbach011dafb2011-09-30 19:58:46 +00004040 APFloat Fabs = F;
4041 Fabs.clearSign();
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004042 if (!Lossy &&
Jim Grosbach011dafb2011-09-30 19:58:46 +00004043 ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
4044 APFloat::cmpLessThan) || Fabs.isZero()))
Jim Grosbach24ff8342011-09-30 18:45:50 +00004045
Benjamin Kramercbb18e92011-03-31 10:12:07 +00004046 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
4047 ConstantFP::get(RHSC->getContext(), F));
4048 break;
4049 }
Chris Lattner2188e402010-01-04 07:37:31 +00004050 case Instruction::PHI:
4051 // Only fold fcmp into the PHI if the phi and fcmp are in the same
4052 // block. If in the same block, we're encouraging jump threading. If
4053 // not, we are just pessimizing the code by making an i1 phi.
4054 if (LHSI->getParent() == I.getParent())
Chris Lattnerea7131a2011-01-16 05:14:26 +00004055 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner2188e402010-01-04 07:37:31 +00004056 return NV;
4057 break;
4058 case Instruction::SIToFP:
4059 case Instruction::UIToFP:
4060 if (Instruction *NV = FoldFCmp_IntToFP_Cst(I, LHSI, RHSC))
4061 return NV;
4062 break;
Benjamin Kramera8c5d082011-03-31 10:12:15 +00004063 case Instruction::FSub: {
4064 // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
4065 Value *Op;
4066 if (match(LHSI, m_FNeg(m_Value(Op))))
4067 return new FCmpInst(I.getSwappedPredicate(), Op,
4068 ConstantExpr::getFNeg(RHSC));
4069 break;
4070 }
Dan Gohman94732022010-02-24 06:46:09 +00004071 case Instruction::Load:
4072 if (GetElementPtrInst *GEP =
4073 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
4074 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
4075 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
4076 !cast<LoadInst>(LHSI)->isVolatile())
4077 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
4078 return Res;
4079 }
4080 break;
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004081 case Instruction::Call: {
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004082 if (!RHSC->isNullValue())
4083 break;
4084
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004085 CallInst *CI = cast<CallInst>(LHSI);
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004086 const Function *F = CI->getCalledFunction();
4087 if (!F)
4088 break;
4089
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004090 // Various optimization for fabs compared with zero.
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004091 LibFunc::Func Func;
4092 if (F->getIntrinsicID() == Intrinsic::fabs ||
4093 (TLI->getLibFunc(F->getName(), Func) && TLI->has(Func) &&
4094 (Func == LibFunc::fabs || Func == LibFunc::fabsf ||
4095 Func == LibFunc::fabsl))) {
4096 switch (I.getPredicate()) {
4097 default:
4098 break;
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004099 // fabs(x) < 0 --> false
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004100 case FCmpInst::FCMP_OLT:
4101 return ReplaceInstUsesWith(I, Builder->getFalse());
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004102 // fabs(x) > 0 --> x != 0
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004103 case FCmpInst::FCMP_OGT:
4104 return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0), RHSC);
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004105 // fabs(x) <= 0 --> x == 0
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004106 case FCmpInst::FCMP_OLE:
4107 return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0), RHSC);
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004108 // fabs(x) >= 0 --> !isnan(x)
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004109 case FCmpInst::FCMP_OGE:
4110 return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0), RHSC);
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004111 // fabs(x) == 0 --> x == 0
4112 // fabs(x) != 0 --> x != 0
Matt Arsenaultb935d9d2015-01-08 20:09:34 +00004113 case FCmpInst::FCMP_OEQ:
4114 case FCmpInst::FCMP_UEQ:
4115 case FCmpInst::FCMP_ONE:
4116 case FCmpInst::FCMP_UNE:
4117 return new FCmpInst(I.getPredicate(), CI->getArgOperand(0), RHSC);
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00004118 }
4119 }
4120 }
Chris Lattner2188e402010-01-04 07:37:31 +00004121 }
Chris Lattner2188e402010-01-04 07:37:31 +00004122 }
4123
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00004124 // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
Benjamin Kramerd159d942011-03-31 10:12:22 +00004125 Value *X, *Y;
4126 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00004127 return new FCmpInst(I.getSwappedPredicate(), X, Y);
Benjamin Kramerd159d942011-03-31 10:12:22 +00004128
Benjamin Kramer2ccfbc82011-03-31 10:11:58 +00004129 // fcmp (fpext x), (fpext y) -> fcmp x, y
4130 if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
4131 if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
4132 if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
4133 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
4134 RHSExt->getOperand(0));
4135
Craig Topperf40110f2014-04-25 05:29:35 +00004136 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00004137}