blob: 4cf836c03b213795355d623300e6a8a090dfe2b5 [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
14#include "InstCombine.h"
Eli Friedman911e12f2011-07-20 21:57:23 +000015#include "llvm/Analysis/ConstantFolding.h"
Chris Lattner2188e402010-01-04 07:37:31 +000016#include "llvm/Analysis/InstructionSimplify.h"
17#include "llvm/Analysis/MemoryBuiltins.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000018#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000019#include "llvm/IR/DataLayout.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000020#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000021#include "llvm/IR/IntrinsicInst.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000022#include "llvm/IR/PatternMatch.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000023#include "llvm/Target/TargetLibraryInfo.h"
Chris Lattner2188e402010-01-04 07:37:31 +000024using namespace llvm;
25using namespace PatternMatch;
26
Chandler Carruth964daaa2014-04-22 02:55:47 +000027#define DEBUG_TYPE "instcombine"
28
Chris Lattner98457102011-02-10 05:23:05 +000029static ConstantInt *getOne(Constant *C) {
30 return ConstantInt::get(cast<IntegerType>(C->getType()), 1);
31}
32
Chris Lattner2188e402010-01-04 07:37:31 +000033static ConstantInt *ExtractElement(Constant *V, Constant *Idx) {
34 return cast<ConstantInt>(ConstantExpr::getExtractElement(V, Idx));
35}
36
37static bool HasAddOverflow(ConstantInt *Result,
38 ConstantInt *In1, ConstantInt *In2,
39 bool IsSigned) {
Chris Lattnerb1a15122011-07-15 06:08:15 +000040 if (!IsSigned)
Chris Lattner2188e402010-01-04 07:37:31 +000041 return Result->getValue().ult(In1->getValue());
Chris Lattnerb1a15122011-07-15 06:08:15 +000042
43 if (In2->isNegative())
44 return Result->getValue().sgt(In1->getValue());
45 return Result->getValue().slt(In1->getValue());
Chris Lattner2188e402010-01-04 07:37:31 +000046}
47
48/// AddWithOverflow - Compute Result = In1+In2, returning true if the result
49/// overflowed for this type.
50static bool AddWithOverflow(Constant *&Result, Constant *In1,
51 Constant *In2, bool IsSigned = false) {
52 Result = ConstantExpr::getAdd(In1, In2);
53
Chris Lattner229907c2011-07-18 04:54:35 +000054 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
Chris Lattner2188e402010-01-04 07:37:31 +000055 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
56 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
57 if (HasAddOverflow(ExtractElement(Result, Idx),
58 ExtractElement(In1, Idx),
59 ExtractElement(In2, Idx),
60 IsSigned))
61 return true;
62 }
63 return false;
64 }
65
66 return HasAddOverflow(cast<ConstantInt>(Result),
67 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
68 IsSigned);
69}
70
71static bool HasSubOverflow(ConstantInt *Result,
72 ConstantInt *In1, ConstantInt *In2,
73 bool IsSigned) {
Chris Lattnerb1a15122011-07-15 06:08:15 +000074 if (!IsSigned)
Chris Lattner2188e402010-01-04 07:37:31 +000075 return Result->getValue().ugt(In1->getValue());
Jim Grosbach129c52a2011-09-30 18:09:53 +000076
Chris Lattnerb1a15122011-07-15 06:08:15 +000077 if (In2->isNegative())
78 return Result->getValue().slt(In1->getValue());
79
80 return Result->getValue().sgt(In1->getValue());
Chris Lattner2188e402010-01-04 07:37:31 +000081}
82
83/// SubWithOverflow - Compute Result = In1-In2, returning true if the result
84/// overflowed for this type.
85static bool SubWithOverflow(Constant *&Result, Constant *In1,
86 Constant *In2, bool IsSigned = false) {
87 Result = ConstantExpr::getSub(In1, In2);
88
Chris Lattner229907c2011-07-18 04:54:35 +000089 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
Chris Lattner2188e402010-01-04 07:37:31 +000090 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
91 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
92 if (HasSubOverflow(ExtractElement(Result, Idx),
93 ExtractElement(In1, Idx),
94 ExtractElement(In2, Idx),
95 IsSigned))
96 return true;
97 }
98 return false;
99 }
100
101 return HasSubOverflow(cast<ConstantInt>(Result),
102 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
103 IsSigned);
104}
105
106/// isSignBitCheck - Given an exploded icmp instruction, return true if the
107/// comparison only checks the sign bit. If it only checks the sign bit, set
108/// TrueIfSigned if the result of the comparison is true when the input value is
109/// signed.
110static bool isSignBitCheck(ICmpInst::Predicate pred, ConstantInt *RHS,
111 bool &TrueIfSigned) {
112 switch (pred) {
113 case ICmpInst::ICMP_SLT: // True if LHS s< 0
114 TrueIfSigned = true;
115 return RHS->isZero();
116 case ICmpInst::ICMP_SLE: // True if LHS s<= RHS and RHS == -1
117 TrueIfSigned = true;
118 return RHS->isAllOnesValue();
119 case ICmpInst::ICMP_SGT: // True if LHS s> -1
120 TrueIfSigned = false;
121 return RHS->isAllOnesValue();
122 case ICmpInst::ICMP_UGT:
123 // True if LHS u> RHS and RHS == high-bit-mask - 1
124 TrueIfSigned = true;
Chris Lattnerb1a15122011-07-15 06:08:15 +0000125 return RHS->isMaxValue(true);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000126 case ICmpInst::ICMP_UGE:
Chris Lattner2188e402010-01-04 07:37:31 +0000127 // True if LHS u>= RHS and RHS == high-bit-mask (2^7, 2^15, 2^31, etc)
128 TrueIfSigned = true;
129 return RHS->getValue().isSignBit();
130 default:
131 return false;
132 }
133}
134
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000135/// Returns true if the exploded icmp can be expressed as a signed comparison
136/// to zero and updates the predicate accordingly.
137/// The signedness of the comparison is preserved.
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000138static bool isSignTest(ICmpInst::Predicate &pred, const ConstantInt *RHS) {
139 if (!ICmpInst::isSigned(pred))
140 return false;
141
142 if (RHS->isZero())
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000143 return ICmpInst::isRelational(pred);
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000144
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000145 if (RHS->isOne()) {
146 if (pred == ICmpInst::ICMP_SLT) {
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000147 pred = ICmpInst::ICMP_SLE;
148 return true;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000149 }
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000150 } else if (RHS->isAllOnesValue()) {
151 if (pred == ICmpInst::ICMP_SGT) {
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000152 pred = ICmpInst::ICMP_SGE;
153 return true;
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000154 }
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +0000155 }
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +0000156
157 return false;
158}
159
Chris Lattner2188e402010-01-04 07:37:31 +0000160// isHighOnes - Return true if the constant is of the form 1+0+.
161// This is the same as lowones(~X).
162static bool isHighOnes(const ConstantInt *CI) {
163 return (~CI->getValue() + 1).isPowerOf2();
164}
165
Jim Grosbach129c52a2011-09-30 18:09:53 +0000166/// ComputeSignedMinMaxValuesFromKnownBits - Given a signed integer type and a
Chris Lattner2188e402010-01-04 07:37:31 +0000167/// set of known zero and one bits, compute the maximum and minimum values that
168/// could have the specified known zero and known one bits, returning them in
169/// min/max.
170static void ComputeSignedMinMaxValuesFromKnownBits(const APInt& KnownZero,
171 const APInt& KnownOne,
172 APInt& Min, APInt& Max) {
173 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
174 KnownZero.getBitWidth() == Min.getBitWidth() &&
175 KnownZero.getBitWidth() == Max.getBitWidth() &&
176 "KnownZero, KnownOne and Min, Max must have equal bitwidth.");
177 APInt UnknownBits = ~(KnownZero|KnownOne);
178
179 // The minimum value is when all unknown bits are zeros, EXCEPT for the sign
180 // bit if it is unknown.
181 Min = KnownOne;
182 Max = KnownOne|UnknownBits;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000183
Chris Lattner2188e402010-01-04 07:37:31 +0000184 if (UnknownBits.isNegative()) { // Sign bit is unknown
Jay Foad25a5e4c2010-12-01 08:53:58 +0000185 Min.setBit(Min.getBitWidth()-1);
186 Max.clearBit(Max.getBitWidth()-1);
Chris Lattner2188e402010-01-04 07:37:31 +0000187 }
188}
189
190// ComputeUnsignedMinMaxValuesFromKnownBits - Given an unsigned integer type and
191// a set of known zero and one bits, compute the maximum and minimum values that
192// could have the specified known zero and known one bits, returning them in
193// min/max.
194static void ComputeUnsignedMinMaxValuesFromKnownBits(const APInt &KnownZero,
195 const APInt &KnownOne,
196 APInt &Min, APInt &Max) {
197 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
198 KnownZero.getBitWidth() == Min.getBitWidth() &&
199 KnownZero.getBitWidth() == Max.getBitWidth() &&
200 "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth.");
201 APInt UnknownBits = ~(KnownZero|KnownOne);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000202
Chris Lattner2188e402010-01-04 07:37:31 +0000203 // The minimum value is when the unknown bits are all zeros.
204 Min = KnownOne;
205 // The maximum value is when the unknown bits are all ones.
206 Max = KnownOne|UnknownBits;
207}
208
209
210
211/// FoldCmpLoadFromIndexedGlobal - Called we see this pattern:
212/// cmp pred (load (gep GV, ...)), cmpcst
213/// where GV is a global variable with a constant initializer. Try to simplify
214/// this into some simple computation that does not need the load. For example
215/// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
216///
217/// If AndCst is non-null, then the loaded value is masked with that constant
218/// before doing the comparison. This handles cases like "A[i]&4 == 0".
219Instruction *InstCombiner::
220FoldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP, GlobalVariable *GV,
221 CmpInst &ICI, ConstantInt *AndCst) {
Matt Arsenault5aeae182013-08-19 21:40:31 +0000222 // We need TD information to know the pointer size unless this is inbounds.
Craig Topperf40110f2014-04-25 05:29:35 +0000223 if (!GEP->isInBounds() && !DL)
224 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000225
Chris Lattnerfe741762012-01-31 02:55:06 +0000226 Constant *Init = GV->getInitializer();
227 if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
Craig Topperf40110f2014-04-25 05:29:35 +0000228 return nullptr;
Jim Grosbachbdbd7342013-04-05 21:20:12 +0000229
Chris Lattnerfe741762012-01-31 02:55:06 +0000230 uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
Craig Topperf40110f2014-04-25 05:29:35 +0000231 if (ArrayElementCount > 1024) return nullptr; // Don't blow up on huge arrays.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000232
Chris Lattner2188e402010-01-04 07:37:31 +0000233 // There are many forms of this optimization we can handle, for now, just do
234 // the simple index into a single-dimensional array.
235 //
236 // Require: GEP GV, 0, i {{, constant indices}}
237 if (GEP->getNumOperands() < 3 ||
238 !isa<ConstantInt>(GEP->getOperand(1)) ||
239 !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
240 isa<Constant>(GEP->getOperand(2)))
Craig Topperf40110f2014-04-25 05:29:35 +0000241 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000242
243 // Check that indices after the variable are constants and in-range for the
244 // type they index. Collect the indices. This is typically for arrays of
245 // structs.
246 SmallVector<unsigned, 4> LaterIndices;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000247
Chris Lattnerfe741762012-01-31 02:55:06 +0000248 Type *EltTy = Init->getType()->getArrayElementType();
Chris Lattner2188e402010-01-04 07:37:31 +0000249 for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
250 ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
Craig Topperf40110f2014-04-25 05:29:35 +0000251 if (!Idx) return nullptr; // Variable index.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000252
Chris Lattner2188e402010-01-04 07:37:31 +0000253 uint64_t IdxVal = Idx->getZExtValue();
Craig Topperf40110f2014-04-25 05:29:35 +0000254 if ((unsigned)IdxVal != IdxVal) return nullptr; // Too large array index.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000255
Chris Lattner229907c2011-07-18 04:54:35 +0000256 if (StructType *STy = dyn_cast<StructType>(EltTy))
Chris Lattner2188e402010-01-04 07:37:31 +0000257 EltTy = STy->getElementType(IdxVal);
Chris Lattner229907c2011-07-18 04:54:35 +0000258 else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
Craig Topperf40110f2014-04-25 05:29:35 +0000259 if (IdxVal >= ATy->getNumElements()) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000260 EltTy = ATy->getElementType();
261 } else {
Craig Topperf40110f2014-04-25 05:29:35 +0000262 return nullptr; // Unknown type.
Chris Lattner2188e402010-01-04 07:37:31 +0000263 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000264
Chris Lattner2188e402010-01-04 07:37:31 +0000265 LaterIndices.push_back(IdxVal);
266 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000267
Chris Lattner2188e402010-01-04 07:37:31 +0000268 enum { Overdefined = -3, Undefined = -2 };
269
270 // Variables for our state machines.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000271
Chris Lattner2188e402010-01-04 07:37:31 +0000272 // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
273 // "i == 47 | i == 87", where 47 is the first index the condition is true for,
274 // and 87 is the second (and last) index. FirstTrueElement is -2 when
275 // undefined, otherwise set to the first true element. SecondTrueElement is
276 // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
277 int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
278
279 // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
280 // form "i != 47 & i != 87". Same state transitions as for true elements.
281 int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000282
Chris Lattner2188e402010-01-04 07:37:31 +0000283 /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
284 /// define a state machine that triggers for ranges of values that the index
285 /// is true or false for. This triggers on things like "abbbbc"[i] == 'b'.
286 /// This is -2 when undefined, -3 when overdefined, and otherwise the last
287 /// index in the range (inclusive). We use -2 for undefined here because we
288 /// use relative comparisons and don't want 0-1 to match -1.
289 int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000290
Chris Lattner2188e402010-01-04 07:37:31 +0000291 // MagicBitvector - This is a magic bitvector where we set a bit if the
292 // comparison is true for element 'i'. If there are 64 elements or less in
293 // the array, this will fully represent all the comparison results.
294 uint64_t MagicBitvector = 0;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000295
296
Chris Lattner2188e402010-01-04 07:37:31 +0000297 // Scan the array and see if one of our patterns matches.
298 Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
Chris Lattnerfe741762012-01-31 02:55:06 +0000299 for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
300 Constant *Elt = Init->getAggregateElement(i);
Craig Topperf40110f2014-04-25 05:29:35 +0000301 if (!Elt) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000302
Chris Lattner2188e402010-01-04 07:37:31 +0000303 // If this is indexing an array of structures, get the structure element.
304 if (!LaterIndices.empty())
Jay Foad57aa6362011-07-13 10:26:04 +0000305 Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000306
Chris Lattner2188e402010-01-04 07:37:31 +0000307 // If the element is masked, handle it.
308 if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000309
Chris Lattner2188e402010-01-04 07:37:31 +0000310 // Find out if the comparison would be true or false for the i'th element.
311 Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000312 CompareRHS, DL, TLI);
Chris Lattner2188e402010-01-04 07:37:31 +0000313 // If the result is undef for this element, ignore it.
314 if (isa<UndefValue>(C)) {
315 // Extend range state machines to cover this element in case there is an
316 // undef in the middle of the range.
317 if (TrueRangeEnd == (int)i-1)
318 TrueRangeEnd = i;
319 if (FalseRangeEnd == (int)i-1)
320 FalseRangeEnd = i;
321 continue;
322 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000323
Chris Lattner2188e402010-01-04 07:37:31 +0000324 // If we can't compute the result for any of the elements, we have to give
325 // up evaluating the entire conditional.
Craig Topperf40110f2014-04-25 05:29:35 +0000326 if (!isa<ConstantInt>(C)) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000327
Chris Lattner2188e402010-01-04 07:37:31 +0000328 // Otherwise, we know if the comparison is true or false for this element,
329 // update our state machines.
330 bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000331
Chris Lattner2188e402010-01-04 07:37:31 +0000332 // State machine for single/double/range index comparison.
333 if (IsTrueForElt) {
334 // Update the TrueElement state machine.
335 if (FirstTrueElement == Undefined)
336 FirstTrueElement = TrueRangeEnd = i; // First true element.
337 else {
338 // Update double-compare state machine.
339 if (SecondTrueElement == Undefined)
340 SecondTrueElement = i;
341 else
342 SecondTrueElement = Overdefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000343
Chris Lattner2188e402010-01-04 07:37:31 +0000344 // Update range state machine.
345 if (TrueRangeEnd == (int)i-1)
346 TrueRangeEnd = i;
347 else
348 TrueRangeEnd = Overdefined;
349 }
350 } else {
351 // Update the FalseElement state machine.
352 if (FirstFalseElement == Undefined)
353 FirstFalseElement = FalseRangeEnd = i; // First false element.
354 else {
355 // Update double-compare state machine.
356 if (SecondFalseElement == Undefined)
357 SecondFalseElement = i;
358 else
359 SecondFalseElement = Overdefined;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000360
Chris Lattner2188e402010-01-04 07:37:31 +0000361 // Update range state machine.
362 if (FalseRangeEnd == (int)i-1)
363 FalseRangeEnd = i;
364 else
365 FalseRangeEnd = Overdefined;
366 }
367 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000368
369
Chris Lattner2188e402010-01-04 07:37:31 +0000370 // If this element is in range, update our magic bitvector.
371 if (i < 64 && IsTrueForElt)
372 MagicBitvector |= 1ULL << i;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000373
Chris Lattner2188e402010-01-04 07:37:31 +0000374 // If all of our states become overdefined, bail out early. Since the
375 // predicate is expensive, only check it every 8 elements. This is only
376 // really useful for really huge arrays.
377 if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
378 SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
379 FalseRangeEnd == Overdefined)
Craig Topperf40110f2014-04-25 05:29:35 +0000380 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000381 }
382
383 // Now that we've scanned the entire array, emit our new comparison(s). We
384 // order the state machines in complexity of the generated code.
385 Value *Idx = GEP->getOperand(2);
386
Matt Arsenault5aeae182013-08-19 21:40:31 +0000387 // If the index is larger than the pointer size of the target, truncate the
388 // index down like the GEP would do implicitly. We don't have to do this for
389 // an inbounds GEP because the index can't be out of range.
Matt Arsenault84680622013-09-30 21:11:01 +0000390 if (!GEP->isInBounds()) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000391 Type *IntPtrTy = DL->getIntPtrType(GEP->getType());
Matt Arsenault84680622013-09-30 21:11:01 +0000392 unsigned PtrSize = IntPtrTy->getIntegerBitWidth();
393 if (Idx->getType()->getPrimitiveSizeInBits() > PtrSize)
394 Idx = Builder->CreateTrunc(Idx, IntPtrTy);
395 }
Matt Arsenault5aeae182013-08-19 21:40:31 +0000396
Chris Lattner2188e402010-01-04 07:37:31 +0000397 // If the comparison is only true for one or two elements, emit direct
398 // comparisons.
399 if (SecondTrueElement != Overdefined) {
400 // None true -> false.
401 if (FirstTrueElement == Undefined)
Jakub Staszakbddea112013-06-06 20:18:46 +0000402 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000403
Chris Lattner2188e402010-01-04 07:37:31 +0000404 Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000405
Chris Lattner2188e402010-01-04 07:37:31 +0000406 // True for one element -> 'i == 47'.
407 if (SecondTrueElement == Undefined)
408 return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000409
Chris Lattner2188e402010-01-04 07:37:31 +0000410 // True for two elements -> 'i == 47 | i == 72'.
411 Value *C1 = Builder->CreateICmpEQ(Idx, FirstTrueIdx);
412 Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
413 Value *C2 = Builder->CreateICmpEQ(Idx, SecondTrueIdx);
414 return BinaryOperator::CreateOr(C1, C2);
415 }
416
417 // If the comparison is only false for one or two elements, emit direct
418 // comparisons.
419 if (SecondFalseElement != Overdefined) {
420 // None false -> true.
421 if (FirstFalseElement == Undefined)
Jakub Staszakbddea112013-06-06 20:18:46 +0000422 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000423
Chris Lattner2188e402010-01-04 07:37:31 +0000424 Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
425
426 // False for one element -> 'i != 47'.
427 if (SecondFalseElement == Undefined)
428 return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000429
Chris Lattner2188e402010-01-04 07:37:31 +0000430 // False for two elements -> 'i != 47 & i != 72'.
431 Value *C1 = Builder->CreateICmpNE(Idx, FirstFalseIdx);
432 Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
433 Value *C2 = Builder->CreateICmpNE(Idx, SecondFalseIdx);
434 return BinaryOperator::CreateAnd(C1, C2);
435 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000436
Chris Lattner2188e402010-01-04 07:37:31 +0000437 // If the comparison can be replaced with a range comparison for the elements
438 // where it is true, emit the range check.
439 if (TrueRangeEnd != Overdefined) {
440 assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
Jim Grosbach129c52a2011-09-30 18:09:53 +0000441
Chris Lattner2188e402010-01-04 07:37:31 +0000442 // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
443 if (FirstTrueElement) {
444 Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
445 Idx = Builder->CreateAdd(Idx, Offs);
446 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000447
Chris Lattner2188e402010-01-04 07:37:31 +0000448 Value *End = ConstantInt::get(Idx->getType(),
449 TrueRangeEnd-FirstTrueElement+1);
450 return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
451 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000452
Chris Lattner2188e402010-01-04 07:37:31 +0000453 // False range check.
454 if (FalseRangeEnd != Overdefined) {
455 assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
456 // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
457 if (FirstFalseElement) {
458 Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
459 Idx = Builder->CreateAdd(Idx, Offs);
460 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000461
Chris Lattner2188e402010-01-04 07:37:31 +0000462 Value *End = ConstantInt::get(Idx->getType(),
463 FalseRangeEnd-FirstFalseElement);
464 return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
465 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000466
467
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000468 // If a magic bitvector captures the entire comparison state
Chris Lattner2188e402010-01-04 07:37:31 +0000469 // of this load, replace it with computation that does:
470 // ((magic_cst >> i) & 1) != 0
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000471 {
Craig Topperf40110f2014-04-25 05:29:35 +0000472 Type *Ty = nullptr;
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000473
474 // Look for an appropriate type:
475 // - The type of Idx if the magic fits
476 // - The smallest fitting legal type if we have a DataLayout
477 // - Default to i32
478 if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
479 Ty = Idx->getType();
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000480 else if (DL)
481 Ty = DL->getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000482 else if (ArrayElementCount <= 32)
Chris Lattner2188e402010-01-04 07:37:31 +0000483 Ty = Type::getInt32Ty(Init->getContext());
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000484
Craig Topperf40110f2014-04-25 05:29:35 +0000485 if (Ty) {
Arnaud A. de Grandmaisonf364bc62013-03-22 08:25:01 +0000486 Value *V = Builder->CreateIntCast(Idx, Ty, false);
487 V = Builder->CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
488 V = Builder->CreateAnd(ConstantInt::get(Ty, 1), V);
489 return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
490 }
Chris Lattner2188e402010-01-04 07:37:31 +0000491 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000492
Craig Topperf40110f2014-04-25 05:29:35 +0000493 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000494}
495
496
497/// EvaluateGEPOffsetExpression - Return a value that can be used to compare
498/// the *offset* implied by a GEP to zero. For example, if we have &A[i], we
499/// want to return 'i' for "icmp ne i, 0". Note that, in general, indices can
500/// be complex, and scales are involved. The above expression would also be
501/// legal to codegen as "icmp ne (i*4), 0" (assuming A is a pointer to i32).
502/// This later form is less amenable to optimization though, and we are allowed
503/// to generate the first by knowing that pointer arithmetic doesn't overflow.
504///
505/// If we can't emit an optimized form for this expression, this returns null.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000506///
Eli Friedman1754a252011-05-18 23:11:30 +0000507static Value *EvaluateGEPOffsetExpression(User *GEP, InstCombiner &IC) {
Rafael Espindolaaeff8a92014-02-24 23:12:18 +0000508 const DataLayout &DL = *IC.getDataLayout();
Chris Lattner2188e402010-01-04 07:37:31 +0000509 gep_type_iterator GTI = gep_type_begin(GEP);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000510
Chris Lattner2188e402010-01-04 07:37:31 +0000511 // Check to see if this gep only has a single variable index. If so, and if
512 // any constant indices are a multiple of its scale, then we can compute this
513 // in terms of the scale of the variable index. For example, if the GEP
514 // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
515 // because the expression will cross zero at the same point.
516 unsigned i, e = GEP->getNumOperands();
517 int64_t Offset = 0;
518 for (i = 1; i != e; ++i, ++GTI) {
519 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
520 // Compute the aggregate offset of constant indices.
521 if (CI->isZero()) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000522
Chris Lattner2188e402010-01-04 07:37:31 +0000523 // Handle a struct index, which adds its field offset to the pointer.
Chris Lattner229907c2011-07-18 04:54:35 +0000524 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000525 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
Chris Lattner2188e402010-01-04 07:37:31 +0000526 } else {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000527 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner2188e402010-01-04 07:37:31 +0000528 Offset += Size*CI->getSExtValue();
529 }
530 } else {
531 // Found our variable index.
532 break;
533 }
534 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000535
Chris Lattner2188e402010-01-04 07:37:31 +0000536 // If there are no variable indices, we must have a constant offset, just
537 // evaluate it the general way.
Craig Topperf40110f2014-04-25 05:29:35 +0000538 if (i == e) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000539
Chris Lattner2188e402010-01-04 07:37:31 +0000540 Value *VariableIdx = GEP->getOperand(i);
541 // Determine the scale factor of the variable element. For example, this is
542 // 4 if the variable index is into an array of i32.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000543 uint64_t VariableScale = DL.getTypeAllocSize(GTI.getIndexedType());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000544
Chris Lattner2188e402010-01-04 07:37:31 +0000545 // Verify that there are no other variable indices. If so, emit the hard way.
546 for (++i, ++GTI; i != e; ++i, ++GTI) {
547 ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
Craig Topperf40110f2014-04-25 05:29:35 +0000548 if (!CI) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000549
Chris Lattner2188e402010-01-04 07:37:31 +0000550 // Compute the aggregate offset of constant indices.
551 if (CI->isZero()) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000552
Chris Lattner2188e402010-01-04 07:37:31 +0000553 // Handle a struct index, which adds its field offset to the pointer.
Chris Lattner229907c2011-07-18 04:54:35 +0000554 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000555 Offset += DL.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
Chris Lattner2188e402010-01-04 07:37:31 +0000556 } else {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000557 uint64_t Size = DL.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner2188e402010-01-04 07:37:31 +0000558 Offset += Size*CI->getSExtValue();
559 }
560 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000561
Matt Arsenault745101d2013-08-21 19:53:10 +0000562
563
Chris Lattner2188e402010-01-04 07:37:31 +0000564 // Okay, we know we have a single variable index, which must be a
565 // pointer/array/vector index. If there is no offset, life is simple, return
566 // the index.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000567 Type *IntPtrTy = DL.getIntPtrType(GEP->getOperand(0)->getType());
Matt Arsenault745101d2013-08-21 19:53:10 +0000568 unsigned IntPtrWidth = IntPtrTy->getIntegerBitWidth();
Chris Lattner2188e402010-01-04 07:37:31 +0000569 if (Offset == 0) {
570 // Cast to intptrty in case a truncation occurs. If an extension is needed,
571 // we don't need to bother extending: the extension won't affect where the
572 // computation crosses zero.
Eli Friedman1754a252011-05-18 23:11:30 +0000573 if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) {
Eli Friedman1754a252011-05-18 23:11:30 +0000574 VariableIdx = IC.Builder->CreateTrunc(VariableIdx, IntPtrTy);
575 }
Chris Lattner2188e402010-01-04 07:37:31 +0000576 return VariableIdx;
577 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000578
Chris Lattner2188e402010-01-04 07:37:31 +0000579 // Otherwise, there is an index. The computation we will do will be modulo
580 // the pointer size, so get it.
581 uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000582
Chris Lattner2188e402010-01-04 07:37:31 +0000583 Offset &= PtrSizeMask;
584 VariableScale &= PtrSizeMask;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000585
Chris Lattner2188e402010-01-04 07:37:31 +0000586 // To do this transformation, any constant index must be a multiple of the
587 // variable scale factor. For example, we can evaluate "12 + 4*i" as "3 + i",
588 // but we can't evaluate "10 + 3*i" in terms of i. Check that the offset is a
589 // multiple of the variable scale.
590 int64_t NewOffs = Offset / (int64_t)VariableScale;
591 if (Offset != NewOffs*(int64_t)VariableScale)
Craig Topperf40110f2014-04-25 05:29:35 +0000592 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000593
Chris Lattner2188e402010-01-04 07:37:31 +0000594 // Okay, we can do this evaluation. Start by converting the index to intptr.
Chris Lattner2188e402010-01-04 07:37:31 +0000595 if (VariableIdx->getType() != IntPtrTy)
Eli Friedman1754a252011-05-18 23:11:30 +0000596 VariableIdx = IC.Builder->CreateIntCast(VariableIdx, IntPtrTy,
597 true /*Signed*/);
Chris Lattner2188e402010-01-04 07:37:31 +0000598 Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
Eli Friedman1754a252011-05-18 23:11:30 +0000599 return IC.Builder->CreateAdd(VariableIdx, OffsetVal, "offset");
Chris Lattner2188e402010-01-04 07:37:31 +0000600}
601
602/// FoldGEPICmp - Fold comparisons between a GEP instruction and something
603/// else. At this point we know that the GEP is on the LHS of the comparison.
604Instruction *InstCombiner::FoldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
605 ICmpInst::Predicate Cond,
606 Instruction &I) {
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000607 // Don't transform signed compares of GEPs into index compares. Even if the
608 // GEP is inbounds, the final add of the base pointer can have signed overflow
609 // and would change the result of the icmp.
610 // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
Benjamin Kramerc7a22fe2012-02-21 13:40:06 +0000611 // the maximum signed value for the pointer type.
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000612 if (ICmpInst::isSigned(Cond))
Craig Topperf40110f2014-04-25 05:29:35 +0000613 return nullptr;
Benjamin Kramer6ee86902012-02-21 13:31:09 +0000614
Matt Arsenault44f60d02014-06-09 19:20:29 +0000615 // Look through bitcasts and addrspacecasts. We do not however want to remove
616 // 0 GEPs.
617 if (!isa<GetElementPtrInst>(RHS))
618 RHS = RHS->stripPointerCasts();
Chris Lattner2188e402010-01-04 07:37:31 +0000619
620 Value *PtrBase = GEPLHS->getOperand(0);
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000621 if (DL && PtrBase == RHS && GEPLHS->isInBounds()) {
Chris Lattner2188e402010-01-04 07:37:31 +0000622 // ((gep Ptr, OFFSET) cmp Ptr) ---> (OFFSET cmp 0).
623 // This transformation (ignoring the base and scales) is valid because we
624 // know pointers can't overflow since the gep is inbounds. See if we can
625 // output an optimized form.
Eli Friedman1754a252011-05-18 23:11:30 +0000626 Value *Offset = EvaluateGEPOffsetExpression(GEPLHS, *this);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000627
Chris Lattner2188e402010-01-04 07:37:31 +0000628 // If not, synthesize the offset the hard way.
Craig Topperf40110f2014-04-25 05:29:35 +0000629 if (!Offset)
Chris Lattner2188e402010-01-04 07:37:31 +0000630 Offset = EmitGEPOffset(GEPLHS);
631 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
632 Constant::getNullValue(Offset->getType()));
633 } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
634 // If the base pointers are different, but the indices are the same, just
635 // compare the base pointer.
636 if (PtrBase != GEPRHS->getOperand(0)) {
637 bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
638 IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
639 GEPRHS->getOperand(0)->getType();
640 if (IndicesTheSame)
641 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
642 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
643 IndicesTheSame = false;
644 break;
645 }
646
647 // If all indices are the same, just compare the base pointers.
648 if (IndicesTheSame)
David Majnemer5953d372013-06-29 10:28:04 +0000649 return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +0000650
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000651 // If we're comparing GEPs with two base pointers that only differ in type
652 // and both GEPs have only constant indices or just one use, then fold
653 // the compare with the adjusted indices.
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000654 if (DL && GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000655 (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
656 (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
657 PtrBase->stripPointerCasts() ==
658 GEPRHS->getOperand(0)->stripPointerCasts()) {
Matt Arsenault44f60d02014-06-09 19:20:29 +0000659 Value *LOffset = EmitGEPOffset(GEPLHS);
660 Value *ROffset = EmitGEPOffset(GEPRHS);
661
662 // If we looked through an addrspacecast between different sized address
663 // spaces, the LHS and RHS pointers are different sized
664 // integers. Truncate to the smaller one.
665 Type *LHSIndexTy = LOffset->getType();
666 Type *RHSIndexTy = ROffset->getType();
667 if (LHSIndexTy != RHSIndexTy) {
668 if (LHSIndexTy->getPrimitiveSizeInBits() <
669 RHSIndexTy->getPrimitiveSizeInBits()) {
670 ROffset = Builder->CreateTrunc(ROffset, LHSIndexTy);
671 } else
672 LOffset = Builder->CreateTrunc(LOffset, RHSIndexTy);
673 }
674
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000675 Value *Cmp = Builder->CreateICmp(ICmpInst::getSignedPredicate(Cond),
Matt Arsenault44f60d02014-06-09 19:20:29 +0000676 LOffset, ROffset);
Benjamin Kramer7adb1892012-02-20 15:07:47 +0000677 return ReplaceInstUsesWith(I, Cmp);
678 }
679
Chris Lattner2188e402010-01-04 07:37:31 +0000680 // Otherwise, the base pointers are different and the indices are
681 // different, bail out.
Craig Topperf40110f2014-04-25 05:29:35 +0000682 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000683 }
684
685 // If one of the GEPs has all zero indices, recurse.
Benjamin Kramerd0993e02014-07-07 11:01:16 +0000686 if (GEPLHS->hasAllZeroIndices())
Chris Lattner2188e402010-01-04 07:37:31 +0000687 return FoldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
David Majnemer92a8a7d2013-06-29 09:45:35 +0000688 ICmpInst::getSwappedPredicate(Cond), I);
Chris Lattner2188e402010-01-04 07:37:31 +0000689
690 // If the other GEP has all zero indices, recurse.
Benjamin Kramerd0993e02014-07-07 11:01:16 +0000691 if (GEPRHS->hasAllZeroIndices())
Chris Lattner2188e402010-01-04 07:37:31 +0000692 return FoldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
693
Stuart Hastings66a82b92011-05-14 05:55:10 +0000694 bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
Chris Lattner2188e402010-01-04 07:37:31 +0000695 if (GEPLHS->getNumOperands() == GEPRHS->getNumOperands()) {
696 // If the GEPs only differ by one index, compare it.
697 unsigned NumDifferences = 0; // Keep track of # differences.
698 unsigned DiffOperand = 0; // The operand that differs.
699 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
700 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
701 if (GEPLHS->getOperand(i)->getType()->getPrimitiveSizeInBits() !=
702 GEPRHS->getOperand(i)->getType()->getPrimitiveSizeInBits()) {
703 // Irreconcilable differences.
704 NumDifferences = 2;
705 break;
706 } else {
707 if (NumDifferences++) break;
708 DiffOperand = i;
709 }
710 }
711
Rafael Espindolaa7bbc0b2013-06-06 17:03:05 +0000712 if (NumDifferences == 0) // SAME GEP?
713 return ReplaceInstUsesWith(I, // No comparison is needed here.
Jakub Staszakbddea112013-06-06 20:18:46 +0000714 Builder->getInt1(ICmpInst::isTrueWhenEqual(Cond)));
Chris Lattner2188e402010-01-04 07:37:31 +0000715
Stuart Hastings66a82b92011-05-14 05:55:10 +0000716 else if (NumDifferences == 1 && GEPsInBounds) {
Chris Lattner2188e402010-01-04 07:37:31 +0000717 Value *LHSV = GEPLHS->getOperand(DiffOperand);
718 Value *RHSV = GEPRHS->getOperand(DiffOperand);
719 // Make sure we do a signed comparison here.
720 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), LHSV, RHSV);
721 }
722 }
723
724 // Only lower this if the icmp is the only user of the GEP or if we expect
725 // the result to fold to a constant!
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000726 if (DL &&
Stuart Hastings66a82b92011-05-14 05:55:10 +0000727 GEPsInBounds &&
Chris Lattner2188e402010-01-04 07:37:31 +0000728 (isa<ConstantExpr>(GEPLHS) || GEPLHS->hasOneUse()) &&
729 (isa<ConstantExpr>(GEPRHS) || GEPRHS->hasOneUse())) {
730 // ((gep Ptr, OFFSET1) cmp (gep Ptr, OFFSET2) ---> (OFFSET1 cmp OFFSET2)
731 Value *L = EmitGEPOffset(GEPLHS);
732 Value *R = EmitGEPOffset(GEPRHS);
733 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), L, R);
734 }
735 }
Craig Topperf40110f2014-04-25 05:29:35 +0000736 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000737}
738
739/// FoldICmpAddOpCst - Fold "icmp pred (X+CI), X".
Benjamin Kramer0e2d1622013-09-20 22:12:42 +0000740Instruction *InstCombiner::FoldICmpAddOpCst(Instruction &ICI,
Chris Lattner2188e402010-01-04 07:37:31 +0000741 Value *X, ConstantInt *CI,
Benjamin Kramer0e2d1622013-09-20 22:12:42 +0000742 ICmpInst::Predicate Pred) {
Chris Lattner2188e402010-01-04 07:37:31 +0000743 // If we have X+0, exit early (simplifying logic below) and let it get folded
744 // elsewhere. icmp X+0, X -> icmp X, X
745 if (CI->isZero()) {
746 bool isTrue = ICmpInst::isTrueWhenEqual(Pred);
747 return ReplaceInstUsesWith(ICI, ConstantInt::get(ICI.getType(), isTrue));
748 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000749
Chris Lattner2188e402010-01-04 07:37:31 +0000750 // (X+4) == X -> false.
751 if (Pred == ICmpInst::ICMP_EQ)
Jakub Staszakbddea112013-06-06 20:18:46 +0000752 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +0000753
754 // (X+4) != X -> true.
755 if (Pred == ICmpInst::ICMP_NE)
Jakub Staszakbddea112013-06-06 20:18:46 +0000756 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +0000757
Chris Lattner2188e402010-01-04 07:37:31 +0000758 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +0000759 // so the values can never be equal. Similarly for all other "or equals"
Chris Lattner2188e402010-01-04 07:37:31 +0000760 // operators.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000761
Chris Lattner8c92b572010-01-08 17:48:19 +0000762 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255
Chris Lattner2188e402010-01-04 07:37:31 +0000763 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253
764 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0
765 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
Jim Grosbach129c52a2011-09-30 18:09:53 +0000766 Value *R =
Chris Lattner8c92b572010-01-08 17:48:19 +0000767 ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI);
Chris Lattner2188e402010-01-04 07:37:31 +0000768 return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
769 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000770
Chris Lattner2188e402010-01-04 07:37:31 +0000771 // (X+1) >u X --> X <u (0-1) --> X != 255
772 // (X+2) >u X --> X <u (0-2) --> X <u 254
773 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0
Duncan Sandse5220012011-02-17 07:46:37 +0000774 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
Chris Lattner2188e402010-01-04 07:37:31 +0000775 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI));
Jim Grosbach129c52a2011-09-30 18:09:53 +0000776
Chris Lattner2188e402010-01-04 07:37:31 +0000777 unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits();
778 ConstantInt *SMax = ConstantInt::get(X->getContext(),
779 APInt::getSignedMaxValue(BitWidth));
780
781 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127
782 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125
783 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0
784 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1
785 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126
786 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127
Duncan Sandse5220012011-02-17 07:46:37 +0000787 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
Chris Lattner2188e402010-01-04 07:37:31 +0000788 return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI));
Jim Grosbach129c52a2011-09-30 18:09:53 +0000789
Chris Lattner2188e402010-01-04 07:37:31 +0000790 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127
791 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126
792 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
793 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
794 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126
795 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128
Jim Grosbach129c52a2011-09-30 18:09:53 +0000796
Chris Lattner2188e402010-01-04 07:37:31 +0000797 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
Jakub Staszakbddea112013-06-06 20:18:46 +0000798 Constant *C = Builder->getInt(CI->getValue()-1);
Chris Lattner2188e402010-01-04 07:37:31 +0000799 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C));
800}
801
802/// FoldICmpDivCst - Fold "icmp pred, ([su]div X, DivRHS), CmpRHS" where DivRHS
803/// and CmpRHS are both known to be integer constants.
804Instruction *InstCombiner::FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI,
805 ConstantInt *DivRHS) {
806 ConstantInt *CmpRHS = cast<ConstantInt>(ICI.getOperand(1));
807 const APInt &CmpRHSV = CmpRHS->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000808
809 // FIXME: If the operand types don't match the type of the divide
Chris Lattner2188e402010-01-04 07:37:31 +0000810 // then don't attempt this transform. The code below doesn't have the
811 // logic to deal with a signed divide and an unsigned compare (and
Jim Grosbach129c52a2011-09-30 18:09:53 +0000812 // vice versa). This is because (x /s C1) <s C2 produces different
Chris Lattner2188e402010-01-04 07:37:31 +0000813 // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even
Jim Grosbach129c52a2011-09-30 18:09:53 +0000814 // (x /u C1) <u C2. Simply casting the operands and result won't
815 // work. :( The if statement below tests that condition and bails
Chris Lattner98457102011-02-10 05:23:05 +0000816 // if it finds it.
Chris Lattner2188e402010-01-04 07:37:31 +0000817 bool DivIsSigned = DivI->getOpcode() == Instruction::SDiv;
818 if (!ICI.isEquality() && DivIsSigned != ICI.isSigned())
Craig Topperf40110f2014-04-25 05:29:35 +0000819 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000820 if (DivRHS->isZero())
Craig Topperf40110f2014-04-25 05:29:35 +0000821 return nullptr; // The ProdOV computation fails on divide by zero.
Chris Lattner2188e402010-01-04 07:37:31 +0000822 if (DivIsSigned && DivRHS->isAllOnesValue())
Craig Topperf40110f2014-04-25 05:29:35 +0000823 return nullptr; // The overflow computation also screws up here
Chris Lattner43273af2011-02-13 08:07:21 +0000824 if (DivRHS->isOne()) {
825 // This eliminates some funny cases with INT_MIN.
826 ICI.setOperand(0, DivI->getOperand(0)); // X/1 == X.
827 return &ICI;
828 }
Chris Lattner2188e402010-01-04 07:37:31 +0000829
830 // Compute Prod = CI * DivRHS. We are essentially solving an equation
Jim Grosbach129c52a2011-09-30 18:09:53 +0000831 // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and
832 // C2 (CI). By solving for X we can turn this into a range check
833 // instead of computing a divide.
Chris Lattner2188e402010-01-04 07:37:31 +0000834 Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS);
835
836 // Determine if the product overflows by seeing if the product is
837 // not equal to the divide. Make sure we do the same kind of divide
Jim Grosbach129c52a2011-09-30 18:09:53 +0000838 // as in the LHS instruction that we're folding.
Chris Lattner2188e402010-01-04 07:37:31 +0000839 bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) :
840 ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS;
841
842 // Get the ICmp opcode
843 ICmpInst::Predicate Pred = ICI.getPredicate();
844
Chris Lattner98457102011-02-10 05:23:05 +0000845 /// If the division is known to be exact, then there is no remainder from the
846 /// divide, so the covered range size is unit, otherwise it is the divisor.
847 ConstantInt *RangeSize = DivI->isExact() ? getOne(Prod) : DivRHS;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000848
Chris Lattner2188e402010-01-04 07:37:31 +0000849 // Figure out the interval that is being checked. For example, a comparison
Jim Grosbach129c52a2011-09-30 18:09:53 +0000850 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
Chris Lattner2188e402010-01-04 07:37:31 +0000851 // Compute this interval based on the constants involved and the signedness of
852 // the compare/divide. This computes a half-open interval, keeping track of
853 // whether either value in the interval overflows. After analysis each
854 // overflow variable is set to 0 if it's corresponding bound variable is valid
855 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
856 int LoOverflow = 0, HiOverflow = 0;
Craig Topperf40110f2014-04-25 05:29:35 +0000857 Constant *LoBound = nullptr, *HiBound = nullptr;
Chris Lattner98457102011-02-10 05:23:05 +0000858
Chris Lattner2188e402010-01-04 07:37:31 +0000859 if (!DivIsSigned) { // udiv
860 // e.g. X/5 op 3 --> [15, 20)
861 LoBound = Prod;
862 HiOverflow = LoOverflow = ProdOV;
Chris Lattner98457102011-02-10 05:23:05 +0000863 if (!HiOverflow) {
864 // If this is not an exact divide, then many values in the range collapse
865 // to the same result value.
866 HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false);
867 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000868
Chris Lattner2188e402010-01-04 07:37:31 +0000869 } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0.
870 if (CmpRHSV == 0) { // (X / pos) op 0
871 // Can't overflow. e.g. X/2 op 0 --> [-1, 2)
Chris Lattner98457102011-02-10 05:23:05 +0000872 LoBound = ConstantExpr::getNeg(SubOne(RangeSize));
873 HiBound = RangeSize;
Chris Lattner2188e402010-01-04 07:37:31 +0000874 } else if (CmpRHSV.isStrictlyPositive()) { // (X / pos) op pos
875 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20)
876 HiOverflow = LoOverflow = ProdOV;
877 if (!HiOverflow)
Chris Lattner98457102011-02-10 05:23:05 +0000878 HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true);
Chris Lattner2188e402010-01-04 07:37:31 +0000879 } else { // (X / pos) op neg
880 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14)
881 HiBound = AddOne(Prod);
882 LoOverflow = HiOverflow = ProdOV ? -1 : 0;
883 if (!LoOverflow) {
Chris Lattner98457102011-02-10 05:23:05 +0000884 ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +0000885 LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
Chris Lattner98457102011-02-10 05:23:05 +0000886 }
Chris Lattner2188e402010-01-04 07:37:31 +0000887 }
Chris Lattnerb1a15122011-07-15 06:08:15 +0000888 } else if (DivRHS->isNegative()) { // Divisor is < 0.
Chris Lattner98457102011-02-10 05:23:05 +0000889 if (DivI->isExact())
890 RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +0000891 if (CmpRHSV == 0) { // (X / neg) op 0
892 // e.g. X/-5 op 0 --> [-4, 5)
Chris Lattner98457102011-02-10 05:23:05 +0000893 LoBound = AddOne(RangeSize);
894 HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +0000895 if (HiBound == DivRHS) { // -INTMIN = INTMIN
896 HiOverflow = 1; // [INTMIN+1, overflow)
Craig Topperf40110f2014-04-25 05:29:35 +0000897 HiBound = nullptr; // e.g. X/INTMIN = 0 --> X > INTMIN
Chris Lattner2188e402010-01-04 07:37:31 +0000898 }
899 } else if (CmpRHSV.isStrictlyPositive()) { // (X / neg) op pos
900 // e.g. X/-5 op 3 --> [-19, -14)
901 HiBound = AddOne(Prod);
902 HiOverflow = LoOverflow = ProdOV ? -1 : 0;
903 if (!LoOverflow)
Chris Lattner98457102011-02-10 05:23:05 +0000904 LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
Chris Lattner2188e402010-01-04 07:37:31 +0000905 } else { // (X / neg) op neg
906 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20)
907 LoOverflow = HiOverflow = ProdOV;
908 if (!HiOverflow)
Chris Lattner98457102011-02-10 05:23:05 +0000909 HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true);
Chris Lattner2188e402010-01-04 07:37:31 +0000910 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000911
Chris Lattner2188e402010-01-04 07:37:31 +0000912 // Dividing by a negative swaps the condition. LT <-> GT
913 Pred = ICmpInst::getSwappedPredicate(Pred);
914 }
915
916 Value *X = DivI->getOperand(0);
917 switch (Pred) {
918 default: llvm_unreachable("Unhandled icmp opcode!");
919 case ICmpInst::ICMP_EQ:
920 if (LoOverflow && HiOverflow)
Jakub Staszakbddea112013-06-06 20:18:46 +0000921 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner067459c2010-03-05 08:46:26 +0000922 if (HiOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000923 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
924 ICmpInst::ICMP_UGE, X, LoBound);
Chris Lattner067459c2010-03-05 08:46:26 +0000925 if (LoOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000926 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
927 ICmpInst::ICMP_ULT, X, HiBound);
Chris Lattner98457102011-02-10 05:23:05 +0000928 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
929 DivIsSigned, true));
Chris Lattner2188e402010-01-04 07:37:31 +0000930 case ICmpInst::ICMP_NE:
931 if (LoOverflow && HiOverflow)
Jakub Staszakbddea112013-06-06 20:18:46 +0000932 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner067459c2010-03-05 08:46:26 +0000933 if (HiOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000934 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
935 ICmpInst::ICMP_ULT, X, LoBound);
Chris Lattner067459c2010-03-05 08:46:26 +0000936 if (LoOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000937 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
938 ICmpInst::ICMP_UGE, X, HiBound);
Chris Lattner067459c2010-03-05 08:46:26 +0000939 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
940 DivIsSigned, false));
Chris Lattner2188e402010-01-04 07:37:31 +0000941 case ICmpInst::ICMP_ULT:
942 case ICmpInst::ICMP_SLT:
943 if (LoOverflow == +1) // Low bound is greater than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000944 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +0000945 if (LoOverflow == -1) // Low bound is less than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000946 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +0000947 return new ICmpInst(Pred, X, LoBound);
948 case ICmpInst::ICMP_UGT:
949 case ICmpInst::ICMP_SGT:
950 if (HiOverflow == +1) // High bound greater than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000951 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner98457102011-02-10 05:23:05 +0000952 if (HiOverflow == -1) // High bound less than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000953 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +0000954 if (Pred == ICmpInst::ICMP_UGT)
955 return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound);
Chris Lattner98457102011-02-10 05:23:05 +0000956 return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound);
Chris Lattner2188e402010-01-04 07:37:31 +0000957 }
958}
959
Chris Lattnerd369f572011-02-13 07:43:07 +0000960/// FoldICmpShrCst - Handle "icmp(([al]shr X, cst1), cst2)".
961Instruction *InstCombiner::FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *Shr,
962 ConstantInt *ShAmt) {
Chris Lattnerd369f572011-02-13 07:43:07 +0000963 const APInt &CmpRHSV = cast<ConstantInt>(ICI.getOperand(1))->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000964
Chris Lattnerd369f572011-02-13 07:43:07 +0000965 // Check that the shift amount is in range. If not, don't perform
966 // undefined shifts. When the shift is visited it will be
967 // simplified.
968 uint32_t TypeBits = CmpRHSV.getBitWidth();
969 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
Chris Lattner43273af2011-02-13 08:07:21 +0000970 if (ShAmtVal >= TypeBits || ShAmtVal == 0)
Craig Topperf40110f2014-04-25 05:29:35 +0000971 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000972
Chris Lattner43273af2011-02-13 08:07:21 +0000973 if (!ICI.isEquality()) {
974 // If we have an unsigned comparison and an ashr, we can't simplify this.
975 // Similarly for signed comparisons with lshr.
976 if (ICI.isSigned() != (Shr->getOpcode() == Instruction::AShr))
Craig Topperf40110f2014-04-25 05:29:35 +0000977 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000978
Eli Friedman865866e2011-05-25 23:26:20 +0000979 // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv
980 // by a power of 2. Since we already have logic to simplify these,
981 // transform to div and then simplify the resultant comparison.
Chris Lattner43273af2011-02-13 08:07:21 +0000982 if (Shr->getOpcode() == Instruction::AShr &&
Eli Friedman865866e2011-05-25 23:26:20 +0000983 (!Shr->isExact() || ShAmtVal == TypeBits - 1))
Craig Topperf40110f2014-04-25 05:29:35 +0000984 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000985
Chris Lattner43273af2011-02-13 08:07:21 +0000986 // Revisit the shift (to delete it).
987 Worklist.Add(Shr);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000988
Chris Lattner43273af2011-02-13 08:07:21 +0000989 Constant *DivCst =
990 ConstantInt::get(Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal));
Jim Grosbach129c52a2011-09-30 18:09:53 +0000991
Chris Lattner43273af2011-02-13 08:07:21 +0000992 Value *Tmp =
993 Shr->getOpcode() == Instruction::AShr ?
994 Builder->CreateSDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()) :
995 Builder->CreateUDiv(Shr->getOperand(0), DivCst, "", Shr->isExact());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000996
Chris Lattner43273af2011-02-13 08:07:21 +0000997 ICI.setOperand(0, Tmp);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000998
Chris Lattner43273af2011-02-13 08:07:21 +0000999 // If the builder folded the binop, just return it.
1000 BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp);
Craig Topperf40110f2014-04-25 05:29:35 +00001001 if (!TheDiv)
Chris Lattner43273af2011-02-13 08:07:21 +00001002 return &ICI;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001003
Chris Lattner43273af2011-02-13 08:07:21 +00001004 // Otherwise, fold this div/compare.
1005 assert(TheDiv->getOpcode() == Instruction::SDiv ||
1006 TheDiv->getOpcode() == Instruction::UDiv);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001007
Chris Lattner43273af2011-02-13 08:07:21 +00001008 Instruction *Res = FoldICmpDivCst(ICI, TheDiv, cast<ConstantInt>(DivCst));
1009 assert(Res && "This div/cst should have folded!");
1010 return Res;
1011 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001012
1013
Chris Lattnerd369f572011-02-13 07:43:07 +00001014 // If we are comparing against bits always shifted out, the
1015 // comparison cannot succeed.
1016 APInt Comp = CmpRHSV << ShAmtVal;
Jakub Staszakbddea112013-06-06 20:18:46 +00001017 ConstantInt *ShiftedCmpRHS = Builder->getInt(Comp);
Chris Lattnerd369f572011-02-13 07:43:07 +00001018 if (Shr->getOpcode() == Instruction::LShr)
1019 Comp = Comp.lshr(ShAmtVal);
1020 else
1021 Comp = Comp.ashr(ShAmtVal);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001022
Chris Lattnerd369f572011-02-13 07:43:07 +00001023 if (Comp != CmpRHSV) { // Comparing against a bit that we know is zero.
1024 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jakub Staszakbddea112013-06-06 20:18:46 +00001025 Constant *Cst = Builder->getInt1(IsICMP_NE);
Chris Lattnerd369f572011-02-13 07:43:07 +00001026 return ReplaceInstUsesWith(ICI, Cst);
1027 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001028
Chris Lattnerd369f572011-02-13 07:43:07 +00001029 // Otherwise, check to see if the bits shifted out are known to be zero.
1030 // If so, we can compare against the unshifted value:
1031 // (X & 4) >> 1 == 2 --> (X & 4) == 4.
Chris Lattner9bd7fdf2011-02-13 18:30:09 +00001032 if (Shr->hasOneUse() && Shr->isExact())
Chris Lattnerd369f572011-02-13 07:43:07 +00001033 return new ICmpInst(ICI.getPredicate(), Shr->getOperand(0), ShiftedCmpRHS);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001034
Chris Lattnerd369f572011-02-13 07:43:07 +00001035 if (Shr->hasOneUse()) {
1036 // Otherwise strength reduce the shift into an and.
1037 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
Jakub Staszakbddea112013-06-06 20:18:46 +00001038 Constant *Mask = Builder->getInt(Val);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001039
Chris Lattnerd369f572011-02-13 07:43:07 +00001040 Value *And = Builder->CreateAnd(Shr->getOperand(0),
1041 Mask, Shr->getName()+".mask");
1042 return new ICmpInst(ICI.getPredicate(), And, ShiftedCmpRHS);
1043 }
Craig Topperf40110f2014-04-25 05:29:35 +00001044 return nullptr;
Chris Lattnerd369f572011-02-13 07:43:07 +00001045}
1046
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001047/// FoldICmpCstShrCst - Handle "(icmp eq/ne (ashr/lshr const2, A), const1)" ->
1048/// (icmp eq/ne A, Log2(const2/const1)) ->
1049/// (icmp eq/ne A, Log2(const2) - Log2(const1)).
1050Instruction *InstCombiner::FoldICmpCstShrCst(ICmpInst &I, Value *Op, Value *A,
1051 ConstantInt *CI1,
1052 ConstantInt *CI2) {
1053 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1054
1055 auto getConstant = [&I, this](bool IsTrue) {
1056 if (I.getPredicate() == I.ICMP_NE)
1057 IsTrue = !IsTrue;
1058 return ReplaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
1059 };
1060
1061 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1062 if (I.getPredicate() == I.ICMP_NE)
1063 Pred = CmpInst::getInversePredicate(Pred);
1064 return new ICmpInst(Pred, LHS, RHS);
1065 };
1066
1067 APInt AP1 = CI1->getValue();
1068 APInt AP2 = CI2->getValue();
1069
1070 if (!AP1) {
1071 if (!AP2) {
1072 // Both Constants are 0.
1073 return getConstant(true);
1074 }
1075
1076 if (cast<BinaryOperator>(Op)->isExact())
1077 return getConstant(false);
1078
1079 if (AP2.isNegative()) {
1080 // MSB is set, so a lshr with a large enough 'A' would be undefined.
1081 return getConstant(false);
1082 }
1083
1084 // 'A' must be large enough to shift out the highest set bit.
1085 return getICmp(I.ICMP_UGT, A,
1086 ConstantInt::get(A->getType(), AP2.logBase2()));
1087 }
1088
1089 if (!AP2) {
1090 // Shifting 0 by any value gives 0.
1091 return getConstant(false);
1092 }
1093
1094 bool IsAShr = isa<AShrOperator>(Op);
1095 if (AP1 == AP2) {
1096 if (AP1.isAllOnesValue() && IsAShr) {
1097 // Arithmatic shift of -1 is always -1.
1098 return getConstant(true);
1099 }
1100 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1101 }
1102
1103 if (IsAShr) {
1104 if (AP1.isNegative() != AP2.isNegative()) {
1105 // Arithmetic shift will never change the sign.
1106 return getConstant(false);
1107 }
1108 // Both the constants are negative, take their positive to calculate
1109 // log.
1110 if (AP1.isNegative()) {
1111 AP1 = -AP1;
1112 AP2 = -AP2;
1113 }
1114 }
1115
1116 if (AP1.ugt(AP2)) {
1117 // Right-shifting will not increase the value.
1118 return getConstant(false);
1119 }
1120
1121 // Get the distance between the highest bit that's set.
1122 int Shift = AP2.logBase2() - AP1.logBase2();
1123
1124 // Use lshr here, since we've canonicalized to +ve numbers.
1125 if (AP1 == AP2.lshr(Shift))
1126 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1127
1128 // Shifting const2 will never be equal to const1.
1129 return getConstant(false);
1130}
Chris Lattner2188e402010-01-04 07:37:31 +00001131
1132/// visitICmpInstWithInstAndIntCst - Handle "icmp (instr, intcst)".
1133///
1134Instruction *InstCombiner::visitICmpInstWithInstAndIntCst(ICmpInst &ICI,
1135 Instruction *LHSI,
1136 ConstantInt *RHS) {
1137 const APInt &RHSV = RHS->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00001138
Chris Lattner2188e402010-01-04 07:37:31 +00001139 switch (LHSI->getOpcode()) {
1140 case Instruction::Trunc:
1141 if (ICI.isEquality() && LHSI->hasOneUse()) {
1142 // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1143 // of the high bits truncated out of x are known.
1144 unsigned DstBits = LHSI->getType()->getPrimitiveSizeInBits(),
1145 SrcBits = LHSI->getOperand(0)->getType()->getPrimitiveSizeInBits();
Chris Lattner2188e402010-01-04 07:37:31 +00001146 APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0);
Jay Foada0653a32014-05-14 21:14:37 +00001147 computeKnownBits(LHSI->getOperand(0), KnownZero, KnownOne);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001148
Chris Lattner2188e402010-01-04 07:37:31 +00001149 // If all the high bits are known, we can do this xform.
1150 if ((KnownZero|KnownOne).countLeadingOnes() >= SrcBits-DstBits) {
1151 // Pull in the high bits from known-ones set.
Jay Foad583abbc2010-12-07 08:25:19 +00001152 APInt NewRHS = RHS->getValue().zext(SrcBits);
Eli Friedmane0a64d82012-05-11 01:32:59 +00001153 NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits-DstBits);
Chris Lattner2188e402010-01-04 07:37:31 +00001154 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001155 Builder->getInt(NewRHS));
Chris Lattner2188e402010-01-04 07:37:31 +00001156 }
1157 }
1158 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001159
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001160 case Instruction::Xor: // (icmp pred (xor X, XorCst), CI)
1161 if (ConstantInt *XorCst = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00001162 // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1163 // fold the xor.
1164 if ((ICI.getPredicate() == ICmpInst::ICMP_SLT && RHSV == 0) ||
1165 (ICI.getPredicate() == ICmpInst::ICMP_SGT && RHSV.isAllOnesValue())) {
1166 Value *CompareVal = LHSI->getOperand(0);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001167
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001168 // If the sign bit of the XorCst is not set, there is no change to
Chris Lattner2188e402010-01-04 07:37:31 +00001169 // the operation, just stop using the Xor.
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001170 if (!XorCst->isNegative()) {
Chris Lattner2188e402010-01-04 07:37:31 +00001171 ICI.setOperand(0, CompareVal);
1172 Worklist.Add(LHSI);
1173 return &ICI;
1174 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001175
Chris Lattner2188e402010-01-04 07:37:31 +00001176 // Was the old condition true if the operand is positive?
1177 bool isTrueIfPositive = ICI.getPredicate() == ICmpInst::ICMP_SGT;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001178
Chris Lattner2188e402010-01-04 07:37:31 +00001179 // If so, the new one isn't.
1180 isTrueIfPositive ^= true;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001181
Chris Lattner2188e402010-01-04 07:37:31 +00001182 if (isTrueIfPositive)
1183 return new ICmpInst(ICmpInst::ICMP_SGT, CompareVal,
1184 SubOne(RHS));
1185 else
1186 return new ICmpInst(ICmpInst::ICMP_SLT, CompareVal,
1187 AddOne(RHS));
1188 }
1189
1190 if (LHSI->hasOneUse()) {
1191 // (icmp u/s (xor A SignBit), C) -> (icmp s/u A, (xor C SignBit))
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001192 if (!ICI.isEquality() && XorCst->getValue().isSignBit()) {
1193 const APInt &SignBit = XorCst->getValue();
Chris Lattner2188e402010-01-04 07:37:31 +00001194 ICmpInst::Predicate Pred = ICI.isSigned()
1195 ? ICI.getUnsignedPredicate()
1196 : ICI.getSignedPredicate();
1197 return new ICmpInst(Pred, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001198 Builder->getInt(RHSV ^ SignBit));
Chris Lattner2188e402010-01-04 07:37:31 +00001199 }
1200
1201 // (icmp u/s (xor A ~SignBit), C) -> (icmp s/u (xor C ~SignBit), A)
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001202 if (!ICI.isEquality() && XorCst->isMaxValue(true)) {
1203 const APInt &NotSignBit = XorCst->getValue();
Chris Lattner2188e402010-01-04 07:37:31 +00001204 ICmpInst::Predicate Pred = ICI.isSigned()
1205 ? ICI.getUnsignedPredicate()
1206 : ICI.getSignedPredicate();
1207 Pred = ICI.getSwappedPredicate(Pred);
1208 return new ICmpInst(Pred, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001209 Builder->getInt(RHSV ^ NotSignBit));
Chris Lattner2188e402010-01-04 07:37:31 +00001210 }
1211 }
David Majnemer72d76272013-07-09 09:20:58 +00001212
1213 // (icmp ugt (xor X, C), ~C) -> (icmp ult X, C)
1214 // iff -C is a power of 2
1215 if (ICI.getPredicate() == ICmpInst::ICMP_UGT &&
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001216 XorCst->getValue() == ~RHSV && (RHSV + 1).isPowerOf2())
1217 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0), XorCst);
David Majnemer72d76272013-07-09 09:20:58 +00001218
1219 // (icmp ult (xor X, C), -C) -> (icmp uge X, C)
1220 // iff -C is a power of 2
1221 if (ICI.getPredicate() == ICmpInst::ICMP_ULT &&
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001222 XorCst->getValue() == -RHSV && RHSV.isPowerOf2())
1223 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0), XorCst);
Chris Lattner2188e402010-01-04 07:37:31 +00001224 }
1225 break;
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001226 case Instruction::And: // (icmp pred (and X, AndCst), RHS)
Chris Lattner2188e402010-01-04 07:37:31 +00001227 if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) &&
1228 LHSI->getOperand(0)->hasOneUse()) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001229 ConstantInt *AndCst = cast<ConstantInt>(LHSI->getOperand(1));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001230
Chris Lattner2188e402010-01-04 07:37:31 +00001231 // If the LHS is an AND of a truncating cast, we can widen the
1232 // and/compare to be the input width without changing the value
1233 // produced, eliminating a cast.
1234 if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) {
1235 // We can do this transformation if either the AND constant does not
Jim Grosbach129c52a2011-09-30 18:09:53 +00001236 // have its sign bit set or if it is an equality comparison.
Chris Lattner2188e402010-01-04 07:37:31 +00001237 // Extending a relational comparison when we're checking the sign
1238 // bit would not work.
Benjamin Kramer35159c12011-06-12 22:47:53 +00001239 if (ICI.isEquality() ||
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001240 (!AndCst->isNegative() && RHSV.isNonNegative())) {
Benjamin Kramer35159c12011-06-12 22:47:53 +00001241 Value *NewAnd =
Chris Lattner2188e402010-01-04 07:37:31 +00001242 Builder->CreateAnd(Cast->getOperand(0),
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001243 ConstantExpr::getZExt(AndCst, Cast->getSrcTy()));
Benjamin Kramer35159c12011-06-12 22:47:53 +00001244 NewAnd->takeName(LHSI);
Chris Lattner2188e402010-01-04 07:37:31 +00001245 return new ICmpInst(ICI.getPredicate(), NewAnd,
Benjamin Kramer35159c12011-06-12 22:47:53 +00001246 ConstantExpr::getZExt(RHS, Cast->getSrcTy()));
Chris Lattner2188e402010-01-04 07:37:31 +00001247 }
1248 }
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001249
1250 // If the LHS is an AND of a zext, and we have an equality compare, we can
1251 // shrink the and/compare to the smaller type, eliminating the cast.
1252 if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) {
Chris Lattner229907c2011-07-18 04:54:35 +00001253 IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy());
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001254 // Make sure we don't compare the upper bits, SimplifyDemandedBits
1255 // should fold the icmp to true/false in that case.
1256 if (ICI.isEquality() && RHSV.getActiveBits() <= Ty->getBitWidth()) {
1257 Value *NewAnd =
1258 Builder->CreateAnd(Cast->getOperand(0),
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001259 ConstantExpr::getTrunc(AndCst, Ty));
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001260 NewAnd->takeName(LHSI);
1261 return new ICmpInst(ICI.getPredicate(), NewAnd,
1262 ConstantExpr::getTrunc(RHS, Ty));
1263 }
1264 }
1265
Chris Lattner2188e402010-01-04 07:37:31 +00001266 // If this is: (X >> C1) & C2 != C3 (where any shift and any compare
1267 // could exist), turn it into (X & (C2 << C1)) != (C3 << C1). This
1268 // happens a LOT in code produced by the C front-end, for bitfield
1269 // access.
1270 BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0));
1271 if (Shift && !Shift->isShift())
Craig Topperf40110f2014-04-25 05:29:35 +00001272 Shift = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001273
Chris Lattner2188e402010-01-04 07:37:31 +00001274 ConstantInt *ShAmt;
Craig Topperf40110f2014-04-25 05:29:35 +00001275 ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001276
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001277 // This seemingly simple opportunity to fold away a shift turns out to
1278 // be rather complicated. See PR17827
1279 // ( http://llvm.org/bugs/show_bug.cgi?id=17827 ) for details.
Chris Lattner2188e402010-01-04 07:37:31 +00001280 if (ShAmt) {
Kay Tiong Khoo5389f742013-12-02 18:43:59 +00001281 bool CanFold = false;
1282 unsigned ShiftOpcode = Shift->getOpcode();
1283 if (ShiftOpcode == Instruction::AShr) {
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001284 // There may be some constraints that make this possible,
1285 // but nothing simple has been discovered yet.
1286 CanFold = false;
1287 } else if (ShiftOpcode == Instruction::Shl) {
1288 // For a left shift, we can fold if the comparison is not signed.
1289 // We can also fold a signed comparison if the mask value and
1290 // comparison value are not negative. These constraints may not be
1291 // obvious, but we can prove that they are correct using an SMT
Kay Tiong Khooe37d5202013-12-19 18:35:54 +00001292 // solver.
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001293 if (!ICI.isSigned() || (!AndCst->isNegative() && !RHS->isNegative()))
Chris Lattner2188e402010-01-04 07:37:31 +00001294 CanFold = true;
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001295 } else if (ShiftOpcode == Instruction::LShr) {
1296 // For a logical right shift, we can fold if the comparison is not
1297 // signed. We can also fold a signed comparison if the shifted mask
1298 // value and the shifted comparison value are not negative.
1299 // These constraints may not be obvious, but we can prove that they
Kay Tiong Khooe37d5202013-12-19 18:35:54 +00001300 // are correct using an SMT solver.
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001301 if (!ICI.isSigned())
1302 CanFold = true;
1303 else {
1304 ConstantInt *ShiftedAndCst =
1305 cast<ConstantInt>(ConstantExpr::getShl(AndCst, ShAmt));
1306 ConstantInt *ShiftedRHSCst =
1307 cast<ConstantInt>(ConstantExpr::getShl(RHS, ShAmt));
1308
1309 if (!ShiftedAndCst->isNegative() && !ShiftedRHSCst->isNegative())
1310 CanFold = true;
1311 }
Chris Lattner2188e402010-01-04 07:37:31 +00001312 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001313
Chris Lattner2188e402010-01-04 07:37:31 +00001314 if (CanFold) {
1315 Constant *NewCst;
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001316 if (ShiftOpcode == Instruction::Shl)
Chris Lattner2188e402010-01-04 07:37:31 +00001317 NewCst = ConstantExpr::getLShr(RHS, ShAmt);
1318 else
1319 NewCst = ConstantExpr::getShl(RHS, ShAmt);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001320
Chris Lattner2188e402010-01-04 07:37:31 +00001321 // Check to see if we are shifting out any of the bits being
1322 // compared.
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001323 if (ConstantExpr::get(ShiftOpcode, NewCst, ShAmt) != RHS) {
Chris Lattner2188e402010-01-04 07:37:31 +00001324 // If we shifted bits out, the fold is not going to work out.
1325 // As a special case, check to see if this means that the
1326 // result is always true or false now.
1327 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
Jakub Staszakbddea112013-06-06 20:18:46 +00001328 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00001329 if (ICI.getPredicate() == ICmpInst::ICMP_NE)
Jakub Staszakbddea112013-06-06 20:18:46 +00001330 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00001331 } else {
1332 ICI.setOperand(1, NewCst);
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001333 Constant *NewAndCst;
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001334 if (ShiftOpcode == Instruction::Shl)
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001335 NewAndCst = ConstantExpr::getLShr(AndCst, ShAmt);
Chris Lattner2188e402010-01-04 07:37:31 +00001336 else
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001337 NewAndCst = ConstantExpr::getShl(AndCst, ShAmt);
1338 LHSI->setOperand(1, NewAndCst);
Chris Lattner2188e402010-01-04 07:37:31 +00001339 LHSI->setOperand(0, Shift->getOperand(0));
1340 Worklist.Add(Shift); // Shift is dead.
1341 return &ICI;
1342 }
1343 }
1344 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001345
Chris Lattner2188e402010-01-04 07:37:31 +00001346 // Turn ((X >> Y) & C) == 0 into (X & (C << Y)) == 0. The later is
1347 // preferable because it allows the C<<Y expression to be hoisted out
1348 // of a loop if Y is invariant and X is not.
1349 if (Shift && Shift->hasOneUse() && RHSV == 0 &&
1350 ICI.isEquality() && !Shift->isArithmeticShift() &&
1351 !isa<Constant>(Shift->getOperand(0))) {
1352 // Compute C << Y.
1353 Value *NS;
1354 if (Shift->getOpcode() == Instruction::LShr) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001355 NS = Builder->CreateShl(AndCst, Shift->getOperand(1));
Chris Lattner2188e402010-01-04 07:37:31 +00001356 } else {
1357 // Insert a logical shift.
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001358 NS = Builder->CreateLShr(AndCst, Shift->getOperand(1));
Chris Lattner2188e402010-01-04 07:37:31 +00001359 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001360
Chris Lattner2188e402010-01-04 07:37:31 +00001361 // Compute X & (C << Y).
Jim Grosbach129c52a2011-09-30 18:09:53 +00001362 Value *NewAnd =
Chris Lattner2188e402010-01-04 07:37:31 +00001363 Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName());
Jim Grosbach129c52a2011-09-30 18:09:53 +00001364
Chris Lattner2188e402010-01-04 07:37:31 +00001365 ICI.setOperand(0, NewAnd);
1366 return &ICI;
1367 }
Paul Redmond5917f4c2012-12-19 19:47:13 +00001368
David Majnemer0ffccf72014-08-24 09:10:57 +00001369 // (icmp pred (and (or (lshr X, Y), X), 1), 0) -->
1370 // (icmp pred (and X, (or (shl 1, Y), 1), 0))
1371 //
1372 // iff pred isn't signed
1373 {
1374 Value *X, *Y, *LShr;
1375 if (!ICI.isSigned() && RHSV == 0) {
1376 if (match(LHSI->getOperand(1), m_One())) {
1377 Constant *One = cast<Constant>(LHSI->getOperand(1));
1378 Value *Or = LHSI->getOperand(0);
1379 if (match(Or, m_Or(m_Value(LShr), m_Value(X))) &&
1380 match(LShr, m_LShr(m_Specific(X), m_Value(Y)))) {
1381 unsigned UsesRemoved = 0;
1382 if (LHSI->hasOneUse())
1383 ++UsesRemoved;
1384 if (Or->hasOneUse())
1385 ++UsesRemoved;
1386 if (LShr->hasOneUse())
1387 ++UsesRemoved;
1388 Value *NewOr = nullptr;
1389 // Compute X & ((1 << Y) | 1)
1390 if (auto *C = dyn_cast<Constant>(Y)) {
1391 if (UsesRemoved >= 1)
1392 NewOr =
1393 ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One);
1394 } else {
1395 if (UsesRemoved >= 3)
1396 NewOr = Builder->CreateOr(Builder->CreateShl(One, Y,
1397 LShr->getName(),
1398 /*HasNUW=*/true),
1399 One, Or->getName());
1400 }
1401 if (NewOr) {
1402 Value *NewAnd = Builder->CreateAnd(X, NewOr, LHSI->getName());
1403 ICI.setOperand(0, NewAnd);
1404 return &ICI;
1405 }
1406 }
1407 }
1408 }
1409 }
1410
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001411 // Replace ((X & AndCst) > RHSV) with ((X & AndCst) != 0), if any
1412 // bit set in (X & AndCst) will produce a result greater than RHSV.
Paul Redmond5917f4c2012-12-19 19:47:13 +00001413 if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001414 unsigned NTZ = AndCst->getValue().countTrailingZeros();
1415 if ((NTZ < AndCst->getBitWidth()) &&
1416 APInt::getOneBitSet(AndCst->getBitWidth(), NTZ).ugt(RHSV))
Paul Redmond5917f4c2012-12-19 19:47:13 +00001417 return new ICmpInst(ICmpInst::ICMP_NE, LHSI,
1418 Constant::getNullValue(RHS->getType()));
1419 }
Chris Lattner2188e402010-01-04 07:37:31 +00001420 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001421
Chris Lattner2188e402010-01-04 07:37:31 +00001422 // Try to optimize things like "A[i]&42 == 0" to index computations.
1423 if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) {
1424 if (GetElementPtrInst *GEP =
1425 dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1426 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1427 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1428 !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) {
1429 ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1));
1430 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV,ICI, C))
1431 return Res;
1432 }
1433 }
David Majnemer414d4e52013-07-09 08:09:32 +00001434
1435 // X & -C == -C -> X > u ~C
1436 // X & -C != -C -> X <= u ~C
1437 // iff C is a power of 2
1438 if (ICI.isEquality() && RHS == LHSI->getOperand(1) && (-RHSV).isPowerOf2())
1439 return new ICmpInst(
1440 ICI.getPredicate() == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_UGT
1441 : ICmpInst::ICMP_ULE,
1442 LHSI->getOperand(0), SubOne(RHS));
Chris Lattner2188e402010-01-04 07:37:31 +00001443 break;
1444
1445 case Instruction::Or: {
1446 if (!ICI.isEquality() || !RHS->isNullValue() || !LHSI->hasOneUse())
1447 break;
1448 Value *P, *Q;
1449 if (match(LHSI, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1450 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1451 // -> and (icmp eq P, null), (icmp eq Q, null).
Chris Lattner2188e402010-01-04 07:37:31 +00001452 Value *ICIP = Builder->CreateICmp(ICI.getPredicate(), P,
1453 Constant::getNullValue(P->getType()));
1454 Value *ICIQ = Builder->CreateICmp(ICI.getPredicate(), Q,
1455 Constant::getNullValue(Q->getType()));
1456 Instruction *Op;
1457 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1458 Op = BinaryOperator::CreateAnd(ICIP, ICIQ);
1459 else
1460 Op = BinaryOperator::CreateOr(ICIP, ICIQ);
1461 return Op;
1462 }
1463 break;
1464 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001465
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001466 case Instruction::Mul: { // (icmp pred (mul X, Val), CI)
1467 ConstantInt *Val = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1468 if (!Val) break;
1469
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +00001470 // If this is a signed comparison to 0 and the mul is sign preserving,
1471 // use the mul LHS operand instead.
1472 ICmpInst::Predicate pred = ICI.getPredicate();
1473 if (isSignTest(pred, RHS) && !Val->isZero() &&
1474 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1475 return new ICmpInst(Val->isNegative() ?
1476 ICmpInst::getSwappedPredicate(pred) : pred,
1477 LHSI->getOperand(0),
1478 Constant::getNullValue(RHS->getType()));
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001479
1480 break;
1481 }
1482
Chris Lattner2188e402010-01-04 07:37:31 +00001483 case Instruction::Shl: { // (icmp pred (shl X, ShAmt), CI)
Chris Lattner2188e402010-01-04 07:37:31 +00001484 uint32_t TypeBits = RHSV.getBitWidth();
David Majnemerb889e402013-06-28 23:42:03 +00001485 ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1486 if (!ShAmt) {
1487 Value *X;
1488 // (1 << X) pred P2 -> X pred Log2(P2)
1489 if (match(LHSI, m_Shl(m_One(), m_Value(X)))) {
1490 bool RHSVIsPowerOf2 = RHSV.isPowerOf2();
1491 ICmpInst::Predicate Pred = ICI.getPredicate();
1492 if (ICI.isUnsigned()) {
1493 if (!RHSVIsPowerOf2) {
1494 // (1 << X) < 30 -> X <= 4
1495 // (1 << X) <= 30 -> X <= 4
1496 // (1 << X) >= 30 -> X > 4
1497 // (1 << X) > 30 -> X > 4
1498 if (Pred == ICmpInst::ICMP_ULT)
1499 Pred = ICmpInst::ICMP_ULE;
1500 else if (Pred == ICmpInst::ICMP_UGE)
1501 Pred = ICmpInst::ICMP_UGT;
1502 }
1503 unsigned RHSLog2 = RHSV.logBase2();
1504
1505 // (1 << X) >= 2147483648 -> X >= 31 -> X == 31
1506 // (1 << X) > 2147483648 -> X > 31 -> false
1507 // (1 << X) <= 2147483648 -> X <= 31 -> true
1508 // (1 << X) < 2147483648 -> X < 31 -> X != 31
1509 if (RHSLog2 == TypeBits-1) {
1510 if (Pred == ICmpInst::ICMP_UGE)
1511 Pred = ICmpInst::ICMP_EQ;
1512 else if (Pred == ICmpInst::ICMP_UGT)
1513 return ReplaceInstUsesWith(ICI, Builder->getFalse());
1514 else if (Pred == ICmpInst::ICMP_ULE)
1515 return ReplaceInstUsesWith(ICI, Builder->getTrue());
1516 else if (Pred == ICmpInst::ICMP_ULT)
1517 Pred = ICmpInst::ICMP_NE;
1518 }
1519
1520 return new ICmpInst(Pred, X,
1521 ConstantInt::get(RHS->getType(), RHSLog2));
1522 } else if (ICI.isSigned()) {
1523 if (RHSV.isAllOnesValue()) {
1524 // (1 << X) <= -1 -> X == 31
1525 if (Pred == ICmpInst::ICMP_SLE)
1526 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1527 ConstantInt::get(RHS->getType(), TypeBits-1));
1528
1529 // (1 << X) > -1 -> X != 31
1530 if (Pred == ICmpInst::ICMP_SGT)
1531 return new ICmpInst(ICmpInst::ICMP_NE, X,
1532 ConstantInt::get(RHS->getType(), TypeBits-1));
1533 } else if (!RHSV) {
1534 // (1 << X) < 0 -> X == 31
1535 // (1 << X) <= 0 -> X == 31
1536 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1537 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1538 ConstantInt::get(RHS->getType(), TypeBits-1));
1539
1540 // (1 << X) >= 0 -> X != 31
1541 // (1 << X) > 0 -> X != 31
1542 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
1543 return new ICmpInst(ICmpInst::ICMP_NE, X,
1544 ConstantInt::get(RHS->getType(), TypeBits-1));
1545 }
1546 } else if (ICI.isEquality()) {
1547 if (RHSVIsPowerOf2)
1548 return new ICmpInst(
1549 Pred, X, ConstantInt::get(RHS->getType(), RHSV.logBase2()));
1550
1551 return ReplaceInstUsesWith(
1552 ICI, Pred == ICmpInst::ICMP_EQ ? Builder->getFalse()
1553 : Builder->getTrue());
1554 }
1555 }
1556 break;
1557 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001558
Chris Lattner2188e402010-01-04 07:37:31 +00001559 // Check that the shift amount is in range. If not, don't perform
1560 // undefined shifts. When the shift is visited it will be
1561 // simplified.
1562 if (ShAmt->uge(TypeBits))
1563 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001564
Chris Lattner2188e402010-01-04 07:37:31 +00001565 if (ICI.isEquality()) {
1566 // If we are comparing against bits always shifted out, the
1567 // comparison cannot succeed.
1568 Constant *Comp =
1569 ConstantExpr::getShl(ConstantExpr::getLShr(RHS, ShAmt),
1570 ShAmt);
1571 if (Comp != RHS) {// Comparing against a bit that we know is zero.
1572 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jakub Staszakbddea112013-06-06 20:18:46 +00001573 Constant *Cst = Builder->getInt1(IsICMP_NE);
Chris Lattner2188e402010-01-04 07:37:31 +00001574 return ReplaceInstUsesWith(ICI, Cst);
1575 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001576
Chris Lattner98457102011-02-10 05:23:05 +00001577 // If the shift is NUW, then it is just shifting out zeros, no need for an
1578 // AND.
1579 if (cast<BinaryOperator>(LHSI)->hasNoUnsignedWrap())
1580 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1581 ConstantExpr::getLShr(RHS, ShAmt));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001582
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001583 // If the shift is NSW and we compare to 0, then it is just shifting out
1584 // sign bits, no need for an AND either.
1585 if (cast<BinaryOperator>(LHSI)->hasNoSignedWrap() && RHSV == 0)
1586 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1587 ConstantExpr::getLShr(RHS, ShAmt));
1588
Chris Lattner2188e402010-01-04 07:37:31 +00001589 if (LHSI->hasOneUse()) {
1590 // Otherwise strength reduce the shift into an and.
1591 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
Jakub Staszakbddea112013-06-06 20:18:46 +00001592 Constant *Mask = Builder->getInt(APInt::getLowBitsSet(TypeBits,
1593 TypeBits - ShAmtVal));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001594
Chris Lattner2188e402010-01-04 07:37:31 +00001595 Value *And =
1596 Builder->CreateAnd(LHSI->getOperand(0),Mask, LHSI->getName()+".mask");
1597 return new ICmpInst(ICI.getPredicate(), And,
Chris Lattner98457102011-02-10 05:23:05 +00001598 ConstantExpr::getLShr(RHS, ShAmt));
Chris Lattner2188e402010-01-04 07:37:31 +00001599 }
1600 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001601
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001602 // If this is a signed comparison to 0 and the shift is sign preserving,
1603 // use the shift LHS operand instead.
1604 ICmpInst::Predicate pred = ICI.getPredicate();
1605 if (isSignTest(pred, RHS) &&
1606 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1607 return new ICmpInst(pred,
1608 LHSI->getOperand(0),
1609 Constant::getNullValue(RHS->getType()));
1610
Chris Lattner2188e402010-01-04 07:37:31 +00001611 // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
1612 bool TrueIfSigned = false;
1613 if (LHSI->hasOneUse() &&
1614 isSignBitCheck(ICI.getPredicate(), RHS, TrueIfSigned)) {
1615 // (X << 31) <s 0 --> (X&1) != 0
Chris Lattner43273af2011-02-13 08:07:21 +00001616 Constant *Mask = ConstantInt::get(LHSI->getOperand(0)->getType(),
Jim Grosbach129c52a2011-09-30 18:09:53 +00001617 APInt::getOneBitSet(TypeBits,
Chris Lattner43273af2011-02-13 08:07:21 +00001618 TypeBits-ShAmt->getZExtValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00001619 Value *And =
1620 Builder->CreateAnd(LHSI->getOperand(0), Mask, LHSI->getName()+".mask");
1621 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
1622 And, Constant::getNullValue(And->getType()));
1623 }
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00001624
1625 // Transform (icmp pred iM (shl iM %v, N), CI)
Arnaud A. de Grandmaison71533052013-03-13 14:40:37 +00001626 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (CI>>N))
1627 // 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 +00001628 // This enables to get rid of the shift in favor of a trunc which can be
1629 // free on the target. It has the additional benefit of comparing to a
1630 // smaller constant, which will be target friendly.
1631 unsigned Amt = ShAmt->getLimitedValue(TypeBits-1);
Arnaud A. de Grandmaison71533052013-03-13 14:40:37 +00001632 if (LHSI->hasOneUse() &&
1633 Amt != 0 && RHSV.countTrailingZeros() >= Amt) {
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00001634 Type *NTy = IntegerType::get(ICI.getContext(), TypeBits - Amt);
1635 Constant *NCI = ConstantExpr::getTrunc(
1636 ConstantExpr::getAShr(RHS,
1637 ConstantInt::get(RHS->getType(), Amt)),
1638 NTy);
1639 return new ICmpInst(ICI.getPredicate(),
1640 Builder->CreateTrunc(LHSI->getOperand(0), NTy),
Arnaud A. de Grandmaison1fd843e2013-02-15 15:18:17 +00001641 NCI);
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00001642 }
1643
Chris Lattner2188e402010-01-04 07:37:31 +00001644 break;
1645 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001646
Chris Lattner2188e402010-01-04 07:37:31 +00001647 case Instruction::LShr: // (icmp pred (shr X, ShAmt), CI)
Nick Lewycky174a7052011-02-28 08:31:40 +00001648 case Instruction::AShr: {
1649 // Handle equality comparisons of shift-by-constant.
1650 BinaryOperator *BO = cast<BinaryOperator>(LHSI);
1651 if (ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1652 if (Instruction *Res = FoldICmpShrCst(ICI, BO, ShAmt))
Chris Lattnerd369f572011-02-13 07:43:07 +00001653 return Res;
Nick Lewycky174a7052011-02-28 08:31:40 +00001654 }
1655
1656 // Handle exact shr's.
1657 if (ICI.isEquality() && BO->isExact() && BO->hasOneUse()) {
1658 if (RHSV.isMinValue())
1659 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), RHS);
1660 }
Chris Lattner2188e402010-01-04 07:37:31 +00001661 break;
Nick Lewycky174a7052011-02-28 08:31:40 +00001662 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001663
Chris Lattner2188e402010-01-04 07:37:31 +00001664 case Instruction::SDiv:
1665 case Instruction::UDiv:
1666 // Fold: icmp pred ([us]div X, C1), C2 -> range test
Jim Grosbach129c52a2011-09-30 18:09:53 +00001667 // Fold this div into the comparison, producing a range check.
1668 // Determine, based on the divide type, what the range is being
1669 // checked. If there is an overflow on the low or high side, remember
Chris Lattner2188e402010-01-04 07:37:31 +00001670 // it, otherwise compute the range [low, hi) bounding the new value.
1671 // See: InsertRangeTest above for the kinds of replacements possible.
1672 if (ConstantInt *DivRHS = dyn_cast<ConstantInt>(LHSI->getOperand(1)))
1673 if (Instruction *R = FoldICmpDivCst(ICI, cast<BinaryOperator>(LHSI),
1674 DivRHS))
1675 return R;
1676 break;
1677
David Majnemerf2a9a512013-07-09 07:50:59 +00001678 case Instruction::Sub: {
1679 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(0));
1680 if (!LHSC) break;
1681 const APInt &LHSV = LHSC->getValue();
1682
1683 // C1-X <u C2 -> (X|(C2-1)) == C1
1684 // iff C1 & (C2-1) == C2-1
1685 // C2 is a power of 2
1686 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
1687 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == (RHSV - 1))
1688 return new ICmpInst(ICmpInst::ICMP_EQ,
1689 Builder->CreateOr(LHSI->getOperand(1), RHSV - 1),
1690 LHSC);
1691
David Majnemereeed73b2013-07-09 09:24:35 +00001692 // C1-X >u C2 -> (X|C2) != C1
David Majnemerf2a9a512013-07-09 07:50:59 +00001693 // iff C1 & C2 == C2
1694 // C2+1 is a power of 2
1695 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1696 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == RHSV)
1697 return new ICmpInst(ICmpInst::ICMP_NE,
1698 Builder->CreateOr(LHSI->getOperand(1), RHSV), LHSC);
1699 break;
1700 }
1701
Chris Lattner2188e402010-01-04 07:37:31 +00001702 case Instruction::Add:
1703 // Fold: icmp pred (add X, C1), C2
1704 if (!ICI.isEquality()) {
1705 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1706 if (!LHSC) break;
1707 const APInt &LHSV = LHSC->getValue();
1708
1709 ConstantRange CR = ICI.makeConstantRange(ICI.getPredicate(), RHSV)
1710 .subtract(LHSV);
1711
1712 if (ICI.isSigned()) {
1713 if (CR.getLower().isSignBit()) {
1714 return new ICmpInst(ICmpInst::ICMP_SLT, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001715 Builder->getInt(CR.getUpper()));
Chris Lattner2188e402010-01-04 07:37:31 +00001716 } else if (CR.getUpper().isSignBit()) {
1717 return new ICmpInst(ICmpInst::ICMP_SGE, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001718 Builder->getInt(CR.getLower()));
Chris Lattner2188e402010-01-04 07:37:31 +00001719 }
1720 } else {
1721 if (CR.getLower().isMinValue()) {
1722 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001723 Builder->getInt(CR.getUpper()));
Chris Lattner2188e402010-01-04 07:37:31 +00001724 } else if (CR.getUpper().isMinValue()) {
1725 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001726 Builder->getInt(CR.getLower()));
Chris Lattner2188e402010-01-04 07:37:31 +00001727 }
1728 }
David Majnemerfa90a0b2013-07-08 11:53:08 +00001729
David Majnemerbafa5372013-07-09 07:58:32 +00001730 // X-C1 <u C2 -> (X & -C2) == C1
1731 // iff C1 & (C2-1) == 0
1732 // C2 is a power of 2
David Majnemerfa90a0b2013-07-08 11:53:08 +00001733 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
David Majnemerbafa5372013-07-09 07:58:32 +00001734 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == 0)
David Majnemerfa90a0b2013-07-08 11:53:08 +00001735 return new ICmpInst(ICmpInst::ICMP_EQ,
1736 Builder->CreateAnd(LHSI->getOperand(0), -RHSV),
1737 ConstantExpr::getNeg(LHSC));
David Majnemerbafa5372013-07-09 07:58:32 +00001738
David Majnemereeed73b2013-07-09 09:24:35 +00001739 // X-C1 >u C2 -> (X & ~C2) != C1
David Majnemerbafa5372013-07-09 07:58:32 +00001740 // iff C1 & C2 == 0
1741 // C2+1 is a power of 2
1742 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1743 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == 0)
1744 return new ICmpInst(ICmpInst::ICMP_NE,
1745 Builder->CreateAnd(LHSI->getOperand(0), ~RHSV),
1746 ConstantExpr::getNeg(LHSC));
Chris Lattner2188e402010-01-04 07:37:31 +00001747 }
1748 break;
1749 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001750
Chris Lattner2188e402010-01-04 07:37:31 +00001751 // Simplify icmp_eq and icmp_ne instructions with integer constant RHS.
1752 if (ICI.isEquality()) {
1753 bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001754
1755 // If the first operand is (add|sub|and|or|xor|rem) with a constant, and
Chris Lattner2188e402010-01-04 07:37:31 +00001756 // the second operand is a constant, simplify a bit.
1757 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(LHSI)) {
1758 switch (BO->getOpcode()) {
1759 case Instruction::SRem:
1760 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
1761 if (RHSV == 0 && isa<ConstantInt>(BO->getOperand(1)) &&BO->hasOneUse()){
1762 const APInt &V = cast<ConstantInt>(BO->getOperand(1))->getValue();
Dan Gohman4ce1fb12010-04-08 23:03:40 +00001763 if (V.sgt(1) && V.isPowerOf2()) {
Chris Lattner2188e402010-01-04 07:37:31 +00001764 Value *NewRem =
1765 Builder->CreateURem(BO->getOperand(0), BO->getOperand(1),
1766 BO->getName());
1767 return new ICmpInst(ICI.getPredicate(), NewRem,
1768 Constant::getNullValue(BO->getType()));
1769 }
1770 }
1771 break;
1772 case Instruction::Add:
1773 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
1774 if (ConstantInt *BOp1C = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1775 if (BO->hasOneUse())
1776 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1777 ConstantExpr::getSub(RHS, BOp1C));
1778 } else if (RHSV == 0) {
1779 // Replace ((add A, B) != 0) with (A != -B) if A or B is
1780 // efficiently invertible, or if the add has just this one use.
1781 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001782
Chris Lattner2188e402010-01-04 07:37:31 +00001783 if (Value *NegVal = dyn_castNegVal(BOp1))
1784 return new ICmpInst(ICI.getPredicate(), BOp0, NegVal);
Chris Lattner31b106d2011-04-26 20:02:45 +00001785 if (Value *NegVal = dyn_castNegVal(BOp0))
Chris Lattner2188e402010-01-04 07:37:31 +00001786 return new ICmpInst(ICI.getPredicate(), NegVal, BOp1);
Chris Lattner31b106d2011-04-26 20:02:45 +00001787 if (BO->hasOneUse()) {
Chris Lattner2188e402010-01-04 07:37:31 +00001788 Value *Neg = Builder->CreateNeg(BOp1);
1789 Neg->takeName(BO);
1790 return new ICmpInst(ICI.getPredicate(), BOp0, Neg);
1791 }
1792 }
1793 break;
1794 case Instruction::Xor:
1795 // For the xor case, we can xor two constants together, eliminating
1796 // the explicit xor.
Benjamin Kramerc9708492011-06-13 15:24:24 +00001797 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
1798 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
Chris Lattner2188e402010-01-04 07:37:31 +00001799 ConstantExpr::getXor(RHS, BOC));
Benjamin Kramerc9708492011-06-13 15:24:24 +00001800 } else if (RHSV == 0) {
1801 // Replace ((xor A, B) != 0) with (A != B)
Chris Lattner2188e402010-01-04 07:37:31 +00001802 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1803 BO->getOperand(1));
Benjamin Kramerc9708492011-06-13 15:24:24 +00001804 }
Chris Lattner2188e402010-01-04 07:37:31 +00001805 break;
Benjamin Kramerc9708492011-06-13 15:24:24 +00001806 case Instruction::Sub:
1807 // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants.
1808 if (ConstantInt *BOp0C = dyn_cast<ConstantInt>(BO->getOperand(0))) {
1809 if (BO->hasOneUse())
1810 return new ICmpInst(ICI.getPredicate(), BO->getOperand(1),
1811 ConstantExpr::getSub(BOp0C, RHS));
1812 } else if (RHSV == 0) {
1813 // Replace ((sub A, B) != 0) with (A != B)
1814 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1815 BO->getOperand(1));
1816 }
1817 break;
Chris Lattner2188e402010-01-04 07:37:31 +00001818 case Instruction::Or:
1819 // If bits are being or'd in that are not present in the constant we
1820 // are comparing against, then the comparison could never succeed!
Eli Friedman0428a612010-07-29 18:03:33 +00001821 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00001822 Constant *NotCI = ConstantExpr::getNot(RHS);
1823 if (!ConstantExpr::getAnd(BOC, NotCI)->isNullValue())
Jakub Staszakbddea112013-06-06 20:18:46 +00001824 return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
Chris Lattner2188e402010-01-04 07:37:31 +00001825 }
1826 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001827
Chris Lattner2188e402010-01-04 07:37:31 +00001828 case Instruction::And:
1829 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1830 // If bits are being compared against that are and'd out, then the
1831 // comparison can never succeed!
1832 if ((RHSV & ~BOC->getValue()) != 0)
Jakub Staszakbddea112013-06-06 20:18:46 +00001833 return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001834
Chris Lattner2188e402010-01-04 07:37:31 +00001835 // If we have ((X & C) == C), turn it into ((X & C) != 0).
1836 if (RHS == BOC && RHSV.isPowerOf2())
1837 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ :
1838 ICmpInst::ICMP_NE, LHSI,
1839 Constant::getNullValue(RHS->getType()));
Benjamin Kramer9eca5fe2011-07-04 20:16:36 +00001840
1841 // Don't perform the following transforms if the AND has multiple uses
1842 if (!BO->hasOneUse())
1843 break;
1844
Chris Lattner2188e402010-01-04 07:37:31 +00001845 // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
1846 if (BOC->getValue().isSignBit()) {
1847 Value *X = BO->getOperand(0);
1848 Constant *Zero = Constant::getNullValue(X->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00001849 ICmpInst::Predicate pred = isICMP_NE ?
Chris Lattner2188e402010-01-04 07:37:31 +00001850 ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
1851 return new ICmpInst(pred, X, Zero);
1852 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001853
Chris Lattner2188e402010-01-04 07:37:31 +00001854 // ((X & ~7) == 0) --> X < 8
1855 if (RHSV == 0 && isHighOnes(BOC)) {
1856 Value *X = BO->getOperand(0);
1857 Constant *NegX = ConstantExpr::getNeg(BOC);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001858 ICmpInst::Predicate pred = isICMP_NE ?
Chris Lattner2188e402010-01-04 07:37:31 +00001859 ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
1860 return new ICmpInst(pred, X, NegX);
1861 }
1862 }
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001863 break;
1864 case Instruction::Mul:
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +00001865 if (RHSV == 0 && BO->hasNoSignedWrap()) {
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001866 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1867 // The trivial case (mul X, 0) is handled by InstSimplify
1868 // General case : (mul X, C) != 0 iff X != 0
1869 // (mul X, C) == 0 iff X == 0
1870 if (!BOC->isZero())
1871 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1872 Constant::getNullValue(RHS->getType()));
1873 }
1874 }
1875 break;
Chris Lattner2188e402010-01-04 07:37:31 +00001876 default: break;
1877 }
1878 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(LHSI)) {
1879 // Handle icmp {eq|ne} <intrinsic>, intcst.
Chris Lattner54f4e392010-01-05 18:09:56 +00001880 switch (II->getIntrinsicID()) {
1881 case Intrinsic::bswap:
Chris Lattner2188e402010-01-04 07:37:31 +00001882 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00001883 ICI.setOperand(0, II->getArgOperand(0));
Jakub Staszakbddea112013-06-06 20:18:46 +00001884 ICI.setOperand(1, Builder->getInt(RHSV.byteSwap()));
Chris Lattner2188e402010-01-04 07:37:31 +00001885 return &ICI;
Chris Lattner54f4e392010-01-05 18:09:56 +00001886 case Intrinsic::ctlz:
1887 case Intrinsic::cttz:
1888 // ctz(A) == bitwidth(a) -> A == 0 and likewise for !=
1889 if (RHSV == RHS->getType()->getBitWidth()) {
1890 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00001891 ICI.setOperand(0, II->getArgOperand(0));
Chris Lattner54f4e392010-01-05 18:09:56 +00001892 ICI.setOperand(1, ConstantInt::get(RHS->getType(), 0));
1893 return &ICI;
1894 }
1895 break;
1896 case Intrinsic::ctpop:
1897 // popcount(A) == 0 -> A == 0 and likewise for !=
1898 if (RHS->isZero()) {
1899 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00001900 ICI.setOperand(0, II->getArgOperand(0));
Chris Lattner54f4e392010-01-05 18:09:56 +00001901 ICI.setOperand(1, RHS);
1902 return &ICI;
1903 }
1904 break;
1905 default:
Duncan Sands41b4a6b2010-07-12 08:16:59 +00001906 break;
Chris Lattner2188e402010-01-04 07:37:31 +00001907 }
1908 }
1909 }
Craig Topperf40110f2014-04-25 05:29:35 +00001910 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001911}
1912
1913/// visitICmpInstWithCastAndCast - Handle icmp (cast x to y), (cast/cst).
1914/// We only handle extending casts so far.
1915///
1916Instruction *InstCombiner::visitICmpInstWithCastAndCast(ICmpInst &ICI) {
1917 const CastInst *LHSCI = cast<CastInst>(ICI.getOperand(0));
1918 Value *LHSCIOp = LHSCI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00001919 Type *SrcTy = LHSCIOp->getType();
1920 Type *DestTy = LHSCI->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00001921 Value *RHSCIOp;
1922
Jim Grosbach129c52a2011-09-30 18:09:53 +00001923 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
Chris Lattner2188e402010-01-04 07:37:31 +00001924 // integer type is the same size as the pointer type.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001925 if (DL && LHSCI->getOpcode() == Instruction::PtrToInt &&
1926 DL->getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth()) {
Craig Topperf40110f2014-04-25 05:29:35 +00001927 Value *RHSOp = nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001928 if (Constant *RHSC = dyn_cast<Constant>(ICI.getOperand(1))) {
1929 RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
1930 } else if (PtrToIntInst *RHSC = dyn_cast<PtrToIntInst>(ICI.getOperand(1))) {
1931 RHSOp = RHSC->getOperand(0);
1932 // If the pointer types don't match, insert a bitcast.
1933 if (LHSCIOp->getType() != RHSOp->getType())
1934 RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType());
1935 }
1936
1937 if (RHSOp)
1938 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSOp);
1939 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001940
Chris Lattner2188e402010-01-04 07:37:31 +00001941 // The code below only handles extension cast instructions, so far.
1942 // Enforce this.
1943 if (LHSCI->getOpcode() != Instruction::ZExt &&
1944 LHSCI->getOpcode() != Instruction::SExt)
Craig Topperf40110f2014-04-25 05:29:35 +00001945 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001946
1947 bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
1948 bool isSignedCmp = ICI.isSigned();
1949
1950 if (CastInst *CI = dyn_cast<CastInst>(ICI.getOperand(1))) {
1951 // Not an extension from the same type?
1952 RHSCIOp = CI->getOperand(0);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001953 if (RHSCIOp->getType() != LHSCIOp->getType())
Craig Topperf40110f2014-04-25 05:29:35 +00001954 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001955
Chris Lattner2188e402010-01-04 07:37:31 +00001956 // If the signedness of the two casts doesn't agree (i.e. one is a sext
1957 // and the other is a zext), then we can't handle this.
1958 if (CI->getOpcode() != LHSCI->getOpcode())
Craig Topperf40110f2014-04-25 05:29:35 +00001959 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001960
1961 // Deal with equality cases early.
1962 if (ICI.isEquality())
1963 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1964
1965 // A signed comparison of sign extended values simplifies into a
1966 // signed comparison.
1967 if (isSignedCmp && isSignedExt)
1968 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1969
1970 // The other three cases all fold into an unsigned comparison.
1971 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
1972 }
1973
1974 // If we aren't dealing with a constant on the RHS, exit early
1975 ConstantInt *CI = dyn_cast<ConstantInt>(ICI.getOperand(1));
1976 if (!CI)
Craig Topperf40110f2014-04-25 05:29:35 +00001977 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001978
1979 // Compute the constant that would happen if we truncated to SrcTy then
1980 // reextended to DestTy.
1981 Constant *Res1 = ConstantExpr::getTrunc(CI, SrcTy);
1982 Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(),
1983 Res1, DestTy);
1984
1985 // If the re-extended constant didn't change...
1986 if (Res2 == CI) {
1987 // Deal with equality cases early.
1988 if (ICI.isEquality())
1989 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1990
1991 // A signed comparison of sign extended values simplifies into a
1992 // signed comparison.
1993 if (isSignedExt && isSignedCmp)
1994 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1995
1996 // The other three cases all fold into an unsigned comparison.
1997 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, Res1);
1998 }
1999
Jim Grosbach129c52a2011-09-30 18:09:53 +00002000 // The re-extended constant changed so the constant cannot be represented
Chris Lattner2188e402010-01-04 07:37:31 +00002001 // in the shorter type. Consequently, we cannot emit a simple comparison.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002002 // All the cases that fold to true or false will have already been handled
2003 // by SimplifyICmpInst, so only deal with the tricky case.
Chris Lattner2188e402010-01-04 07:37:31 +00002004
Duncan Sands8fb2c382011-01-20 13:21:55 +00002005 if (isSignedCmp || !isSignedExt)
Craig Topperf40110f2014-04-25 05:29:35 +00002006 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002007
2008 // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
2009 // should have been folded away previously and not enter in here.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002010
2011 // We're performing an unsigned comp with a sign extended value.
2012 // This is true if the input is >= 0. [aka >s -1]
2013 Constant *NegOne = Constant::getAllOnesValue(SrcTy);
2014 Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICI.getName());
Chris Lattner2188e402010-01-04 07:37:31 +00002015
2016 // Finally, return the value computed.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002017 if (ICI.getPredicate() == ICmpInst::ICMP_ULT)
Chris Lattner2188e402010-01-04 07:37:31 +00002018 return ReplaceInstUsesWith(ICI, Result);
2019
Duncan Sands8fb2c382011-01-20 13:21:55 +00002020 assert(ICI.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
Chris Lattner2188e402010-01-04 07:37:31 +00002021 return BinaryOperator::CreateNot(Result);
2022}
2023
Chris Lattneree61c1d2010-12-19 17:52:50 +00002024/// ProcessUGT_ADDCST_ADD - The caller has matched a pattern of the form:
2025/// I = icmp ugt (add (add A, B), CI2), CI1
Chris Lattnerc56c8452010-12-19 18:22:06 +00002026/// If this is of the form:
2027/// sum = a + b
2028/// if (sum+128 >u 255)
2029/// Then replace it with llvm.sadd.with.overflow.i8.
2030///
Chris Lattneree61c1d2010-12-19 17:52:50 +00002031static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
2032 ConstantInt *CI2, ConstantInt *CI1,
Chris Lattnerce2995a2010-12-19 18:38:44 +00002033 InstCombiner &IC) {
Chris Lattnerf29562d2010-12-19 17:59:02 +00002034 // The transformation we're trying to do here is to transform this into an
2035 // llvm.sadd.with.overflow. To do this, we have to replace the original add
2036 // with a narrower add, and discard the add-with-constant that is part of the
2037 // range check (if we can't eliminate it, this isn't profitable).
Jim Grosbach129c52a2011-09-30 18:09:53 +00002038
Chris Lattnerf29562d2010-12-19 17:59:02 +00002039 // In order to eliminate the add-with-constant, the compare can be its only
2040 // use.
Chris Lattnerc56c8452010-12-19 18:22:06 +00002041 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
Craig Topperf40110f2014-04-25 05:29:35 +00002042 if (!AddWithCst->hasOneUse()) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002043
Chris Lattnerc56c8452010-12-19 18:22:06 +00002044 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
Craig Topperf40110f2014-04-25 05:29:35 +00002045 if (!CI2->getValue().isPowerOf2()) return nullptr;
Chris Lattnerc56c8452010-12-19 18:22:06 +00002046 unsigned NewWidth = CI2->getValue().countTrailingZeros();
Craig Topperf40110f2014-04-25 05:29:35 +00002047 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002048
Chris Lattnerc56c8452010-12-19 18:22:06 +00002049 // The width of the new add formed is 1 more than the bias.
2050 ++NewWidth;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002051
Chris Lattnerc56c8452010-12-19 18:22:06 +00002052 // Check to see that CI1 is an all-ones value with NewWidth bits.
2053 if (CI1->getBitWidth() == NewWidth ||
2054 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
Craig Topperf40110f2014-04-25 05:29:35 +00002055 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002056
Eli Friedmanb3f9b062011-11-28 23:32:19 +00002057 // This is only really a signed overflow check if the inputs have been
2058 // sign-extended; check for that condition. For example, if CI2 is 2^31 and
2059 // the operands of the add are 64 bits wide, we need at least 33 sign bits.
2060 unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
2061 if (IC.ComputeNumSignBits(A) < NeededSignBits ||
2062 IC.ComputeNumSignBits(B) < NeededSignBits)
Craig Topperf40110f2014-04-25 05:29:35 +00002063 return nullptr;
Eli Friedmanb3f9b062011-11-28 23:32:19 +00002064
Jim Grosbach129c52a2011-09-30 18:09:53 +00002065 // In order to replace the original add with a narrower
Chris Lattnerc56c8452010-12-19 18:22:06 +00002066 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
2067 // and truncates that discard the high bits of the add. Verify that this is
2068 // the case.
2069 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
Chandler Carruthcdf47882014-03-09 03:16:01 +00002070 for (User *U : OrigAdd->users()) {
2071 if (U == AddWithCst) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002072
Chris Lattnerc56c8452010-12-19 18:22:06 +00002073 // Only accept truncates for now. We would really like a nice recursive
2074 // predicate like SimplifyDemandedBits, but which goes downwards the use-def
2075 // chain to see which bits of a value are actually demanded. If the
2076 // original add had another add which was then immediately truncated, we
2077 // could still do the transformation.
Chandler Carruthcdf47882014-03-09 03:16:01 +00002078 TruncInst *TI = dyn_cast<TruncInst>(U);
Craig Topperf40110f2014-04-25 05:29:35 +00002079 if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth)
2080 return nullptr;
Chris Lattnerc56c8452010-12-19 18:22:06 +00002081 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002082
Chris Lattneree61c1d2010-12-19 17:52:50 +00002083 // If the pattern matches, truncate the inputs to the narrower type and
2084 // use the sadd_with_overflow intrinsic to efficiently compute both the
2085 // result and the overflow bit.
Chris Lattner79874562010-12-19 18:35:09 +00002086 Module *M = I.getParent()->getParent()->getParent();
Jim Grosbach129c52a2011-09-30 18:09:53 +00002087
Jay Foadb804a2b2011-07-12 14:06:48 +00002088 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
Chris Lattner79874562010-12-19 18:35:09 +00002089 Value *F = Intrinsic::getDeclaration(M, Intrinsic::sadd_with_overflow,
Benjamin Kramere6e19332011-07-14 17:45:39 +00002090 NewType);
Chris Lattner79874562010-12-19 18:35:09 +00002091
Chris Lattnerce2995a2010-12-19 18:38:44 +00002092 InstCombiner::BuilderTy *Builder = IC.Builder;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002093
Chris Lattner79874562010-12-19 18:35:09 +00002094 // Put the new code above the original add, in case there are any uses of the
2095 // add between the add and the compare.
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002096 Builder->SetInsertPoint(OrigAdd);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002097
Chris Lattner79874562010-12-19 18:35:09 +00002098 Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc");
2099 Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc");
2100 CallInst *Call = Builder->CreateCall2(F, TruncA, TruncB, "sadd");
2101 Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result");
2102 Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00002103
Chris Lattneree61c1d2010-12-19 17:52:50 +00002104 // The inner add was the result of the narrow add, zero extended to the
2105 // wider type. Replace it with the result computed by the intrinsic.
Chris Lattnerce2995a2010-12-19 18:38:44 +00002106 IC.ReplaceInstUsesWith(*OrigAdd, ZExt);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002107
Chris Lattner79874562010-12-19 18:35:09 +00002108 // The original icmp gets replaced with the overflow value.
2109 return ExtractValueInst::Create(Call, 1, "sadd.overflow");
Chris Lattneree61c1d2010-12-19 17:52:50 +00002110}
Chris Lattner2188e402010-01-04 07:37:31 +00002111
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002112static Instruction *ProcessUAddIdiom(Instruction &I, Value *OrigAddV,
2113 InstCombiner &IC) {
2114 // Don't bother doing this transformation for pointers, don't do it for
2115 // vectors.
Craig Topperf40110f2014-04-25 05:29:35 +00002116 if (!isa<IntegerType>(OrigAddV->getType())) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002117
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002118 // If the add is a constant expr, then we don't bother transforming it.
2119 Instruction *OrigAdd = dyn_cast<Instruction>(OrigAddV);
Craig Topperf40110f2014-04-25 05:29:35 +00002120 if (!OrigAdd) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002121
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002122 Value *LHS = OrigAdd->getOperand(0), *RHS = OrigAdd->getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002123
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002124 // Put the new code above the original add, in case there are any uses of the
2125 // add between the add and the compare.
2126 InstCombiner::BuilderTy *Builder = IC.Builder;
2127 Builder->SetInsertPoint(OrigAdd);
2128
2129 Module *M = I.getParent()->getParent()->getParent();
Jay Foadb804a2b2011-07-12 14:06:48 +00002130 Type *Ty = LHS->getType();
Benjamin Kramere6e19332011-07-14 17:45:39 +00002131 Value *F = Intrinsic::getDeclaration(M, Intrinsic::uadd_with_overflow, Ty);
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002132 CallInst *Call = Builder->CreateCall2(F, LHS, RHS, "uadd");
2133 Value *Add = Builder->CreateExtractValue(Call, 0);
2134
2135 IC.ReplaceInstUsesWith(*OrigAdd, Add);
2136
2137 // The original icmp gets replaced with the overflow value.
2138 return ExtractValueInst::Create(Call, 1, "uadd.overflow");
2139}
2140
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002141/// \brief Recognize and process idiom involving test for multiplication
2142/// overflow.
2143///
2144/// The caller has matched a pattern of the form:
2145/// I = cmp u (mul(zext A, zext B), V
2146/// The function checks if this is a test for overflow and if so replaces
2147/// multiplication with call to 'mul.with.overflow' intrinsic.
2148///
2149/// \param I Compare instruction.
2150/// \param MulVal Result of 'mult' instruction. It is one of the arguments of
2151/// the compare instruction. Must be of integer type.
2152/// \param OtherVal The other argument of compare instruction.
2153/// \returns Instruction which must replace the compare instruction, NULL if no
2154/// replacement required.
2155static Instruction *ProcessUMulZExtIdiom(ICmpInst &I, Value *MulVal,
2156 Value *OtherVal, InstCombiner &IC) {
Benjamin Kramerc96a7f82014-06-24 10:47:52 +00002157 // Don't bother doing this transformation for pointers, don't do it for
2158 // vectors.
2159 if (!isa<IntegerType>(MulVal->getType()))
2160 return nullptr;
2161
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002162 assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal);
2163 assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002164 Instruction *MulInstr = cast<Instruction>(MulVal);
2165 assert(MulInstr->getOpcode() == Instruction::Mul);
2166
2167 Instruction *LHS = cast<Instruction>(MulInstr->getOperand(0)),
2168 *RHS = cast<Instruction>(MulInstr->getOperand(1));
2169 assert(LHS->getOpcode() == Instruction::ZExt);
2170 assert(RHS->getOpcode() == Instruction::ZExt);
2171 Value *A = LHS->getOperand(0), *B = RHS->getOperand(0);
2172
2173 // Calculate type and width of the result produced by mul.with.overflow.
2174 Type *TyA = A->getType(), *TyB = B->getType();
2175 unsigned WidthA = TyA->getPrimitiveSizeInBits(),
2176 WidthB = TyB->getPrimitiveSizeInBits();
2177 unsigned MulWidth;
2178 Type *MulType;
2179 if (WidthB > WidthA) {
2180 MulWidth = WidthB;
2181 MulType = TyB;
2182 } else {
2183 MulWidth = WidthA;
2184 MulType = TyA;
2185 }
2186
2187 // In order to replace the original mul with a narrower mul.with.overflow,
2188 // all uses must ignore upper bits of the product. The number of used low
2189 // bits must be not greater than the width of mul.with.overflow.
2190 if (MulVal->hasNUsesOrMore(2))
2191 for (User *U : MulVal->users()) {
2192 if (U == &I)
2193 continue;
2194 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2195 // Check if truncation ignores bits above MulWidth.
2196 unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits();
2197 if (TruncWidth > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00002198 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002199 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2200 // Check if AND ignores bits above MulWidth.
2201 if (BO->getOpcode() != Instruction::And)
Craig Topperf40110f2014-04-25 05:29:35 +00002202 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002203 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2204 const APInt &CVal = CI->getValue();
2205 if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00002206 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002207 }
2208 } else {
2209 // Other uses prohibit this transformation.
Craig Topperf40110f2014-04-25 05:29:35 +00002210 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002211 }
2212 }
2213
2214 // Recognize patterns
2215 switch (I.getPredicate()) {
2216 case ICmpInst::ICMP_EQ:
2217 case ICmpInst::ICMP_NE:
2218 // Recognize pattern:
2219 // mulval = mul(zext A, zext B)
2220 // cmp eq/neq mulval, zext trunc mulval
2221 if (ZExtInst *Zext = dyn_cast<ZExtInst>(OtherVal))
2222 if (Zext->hasOneUse()) {
2223 Value *ZextArg = Zext->getOperand(0);
2224 if (TruncInst *Trunc = dyn_cast<TruncInst>(ZextArg))
2225 if (Trunc->getType()->getPrimitiveSizeInBits() == MulWidth)
2226 break; //Recognized
2227 }
2228
2229 // Recognize pattern:
2230 // mulval = mul(zext A, zext B)
2231 // cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits.
2232 ConstantInt *CI;
2233 Value *ValToMask;
2234 if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) {
2235 if (ValToMask != MulVal)
Craig Topperf40110f2014-04-25 05:29:35 +00002236 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002237 const APInt &CVal = CI->getValue() + 1;
2238 if (CVal.isPowerOf2()) {
2239 unsigned MaskWidth = CVal.logBase2();
2240 if (MaskWidth == MulWidth)
2241 break; // Recognized
2242 }
2243 }
Craig Topperf40110f2014-04-25 05:29:35 +00002244 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002245
2246 case ICmpInst::ICMP_UGT:
2247 // Recognize pattern:
2248 // mulval = mul(zext A, zext B)
2249 // cmp ugt mulval, max
2250 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2251 APInt MaxVal = APInt::getMaxValue(MulWidth);
2252 MaxVal = MaxVal.zext(CI->getBitWidth());
2253 if (MaxVal.eq(CI->getValue()))
2254 break; // Recognized
2255 }
Craig Topperf40110f2014-04-25 05:29:35 +00002256 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002257
2258 case ICmpInst::ICMP_UGE:
2259 // Recognize pattern:
2260 // mulval = mul(zext A, zext B)
2261 // cmp uge mulval, max+1
2262 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2263 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
2264 if (MaxVal.eq(CI->getValue()))
2265 break; // Recognized
2266 }
Craig Topperf40110f2014-04-25 05:29:35 +00002267 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002268
2269 case ICmpInst::ICMP_ULE:
2270 // Recognize pattern:
2271 // mulval = mul(zext A, zext B)
2272 // cmp ule mulval, max
2273 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2274 APInt MaxVal = APInt::getMaxValue(MulWidth);
2275 MaxVal = MaxVal.zext(CI->getBitWidth());
2276 if (MaxVal.eq(CI->getValue()))
2277 break; // Recognized
2278 }
Craig Topperf40110f2014-04-25 05:29:35 +00002279 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002280
2281 case ICmpInst::ICMP_ULT:
2282 // Recognize pattern:
2283 // mulval = mul(zext A, zext B)
2284 // cmp ule mulval, max + 1
2285 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00002286 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002287 if (MaxVal.eq(CI->getValue()))
2288 break; // Recognized
2289 }
Craig Topperf40110f2014-04-25 05:29:35 +00002290 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002291
2292 default:
Craig Topperf40110f2014-04-25 05:29:35 +00002293 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002294 }
2295
2296 InstCombiner::BuilderTy *Builder = IC.Builder;
2297 Builder->SetInsertPoint(MulInstr);
2298 Module *M = I.getParent()->getParent()->getParent();
2299
2300 // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B)
2301 Value *MulA = A, *MulB = B;
2302 if (WidthA < MulWidth)
2303 MulA = Builder->CreateZExt(A, MulType);
2304 if (WidthB < MulWidth)
2305 MulB = Builder->CreateZExt(B, MulType);
2306 Value *F =
2307 Intrinsic::getDeclaration(M, Intrinsic::umul_with_overflow, MulType);
2308 CallInst *Call = Builder->CreateCall2(F, MulA, MulB, "umul");
2309 IC.Worklist.Add(MulInstr);
2310
2311 // If there are uses of mul result other than the comparison, we know that
2312 // they are truncation or binary AND. Change them to use result of
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00002313 // mul.with.overflow and adjust properly mask/size.
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002314 if (MulVal->hasNUsesOrMore(2)) {
2315 Value *Mul = Builder->CreateExtractValue(Call, 0, "umul.value");
2316 for (User *U : MulVal->users()) {
2317 if (U == &I || U == OtherVal)
2318 continue;
2319 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2320 if (TI->getType()->getPrimitiveSizeInBits() == MulWidth)
2321 IC.ReplaceInstUsesWith(*TI, Mul);
2322 else
2323 TI->setOperand(0, Mul);
2324 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2325 assert(BO->getOpcode() == Instruction::And);
2326 // Replace (mul & mask) --> zext (mul.with.overflow & short_mask)
2327 ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
2328 APInt ShortMask = CI->getValue().trunc(MulWidth);
2329 Value *ShortAnd = Builder->CreateAnd(Mul, ShortMask);
2330 Instruction *Zext =
2331 cast<Instruction>(Builder->CreateZExt(ShortAnd, BO->getType()));
2332 IC.Worklist.Add(Zext);
2333 IC.ReplaceInstUsesWith(*BO, Zext);
2334 } else {
2335 llvm_unreachable("Unexpected Binary operation");
2336 }
2337 IC.Worklist.Add(cast<Instruction>(U));
2338 }
2339 }
2340 if (isa<Instruction>(OtherVal))
2341 IC.Worklist.Add(cast<Instruction>(OtherVal));
2342
2343 // The original icmp gets replaced with the overflow value, maybe inverted
2344 // depending on predicate.
2345 bool Inverse = false;
2346 switch (I.getPredicate()) {
2347 case ICmpInst::ICMP_NE:
2348 break;
2349 case ICmpInst::ICMP_EQ:
2350 Inverse = true;
2351 break;
2352 case ICmpInst::ICMP_UGT:
2353 case ICmpInst::ICMP_UGE:
2354 if (I.getOperand(0) == MulVal)
2355 break;
2356 Inverse = true;
2357 break;
2358 case ICmpInst::ICMP_ULT:
2359 case ICmpInst::ICMP_ULE:
2360 if (I.getOperand(1) == MulVal)
2361 break;
2362 Inverse = true;
2363 break;
2364 default:
2365 llvm_unreachable("Unexpected predicate");
2366 }
2367 if (Inverse) {
2368 Value *Res = Builder->CreateExtractValue(Call, 1);
2369 return BinaryOperator::CreateNot(Res);
2370 }
2371
2372 return ExtractValueInst::Create(Call, 1);
2373}
2374
Owen Andersond490c2d2011-01-11 00:36:45 +00002375// DemandedBitsLHSMask - When performing a comparison against a constant,
2376// it is possible that not all the bits in the LHS are demanded. This helper
2377// method computes the mask that IS demanded.
2378static APInt DemandedBitsLHSMask(ICmpInst &I,
2379 unsigned BitWidth, bool isSignCheck) {
2380 if (isSignCheck)
2381 return APInt::getSignBit(BitWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002382
Owen Andersond490c2d2011-01-11 00:36:45 +00002383 ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1));
2384 if (!CI) return APInt::getAllOnesValue(BitWidth);
Owen Anderson0022a4b2011-01-11 18:26:37 +00002385 const APInt &RHS = CI->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00002386
Owen Andersond490c2d2011-01-11 00:36:45 +00002387 switch (I.getPredicate()) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00002388 // For a UGT comparison, we don't care about any bits that
Owen Andersond490c2d2011-01-11 00:36:45 +00002389 // correspond to the trailing ones of the comparand. The value of these
2390 // bits doesn't impact the outcome of the comparison, because any value
2391 // greater than the RHS must differ in a bit higher than these due to carry.
2392 case ICmpInst::ICMP_UGT: {
2393 unsigned trailingOnes = RHS.countTrailingOnes();
2394 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes);
2395 return ~lowBitsSet;
2396 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002397
Owen Andersond490c2d2011-01-11 00:36:45 +00002398 // Similarly, for a ULT comparison, we don't care about the trailing zeros.
2399 // Any value less than the RHS must differ in a higher bit because of carries.
2400 case ICmpInst::ICMP_ULT: {
2401 unsigned trailingZeros = RHS.countTrailingZeros();
2402 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros);
2403 return ~lowBitsSet;
2404 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002405
Owen Andersond490c2d2011-01-11 00:36:45 +00002406 default:
2407 return APInt::getAllOnesValue(BitWidth);
2408 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002409
Owen Andersond490c2d2011-01-11 00:36:45 +00002410}
Chris Lattner2188e402010-01-04 07:37:31 +00002411
Quentin Colombet5ab55552013-09-09 20:56:48 +00002412/// \brief Check if the order of \p Op0 and \p Op1 as operand in an ICmpInst
2413/// should be swapped.
Alp Tokercb402912014-01-24 17:20:08 +00002414/// The decision is based on how many times these two operands are reused
Quentin Colombet5ab55552013-09-09 20:56:48 +00002415/// as subtract operands and their positions in those instructions.
2416/// The rational is that several architectures use the same instruction for
2417/// both subtract and cmp, thus it is better if the order of those operands
2418/// match.
2419/// \return true if Op0 and Op1 should be swapped.
2420static bool swapMayExposeCSEOpportunities(const Value * Op0,
2421 const Value * Op1) {
2422 // Filter out pointer value as those cannot appears directly in subtract.
2423 // FIXME: we may want to go through inttoptrs or bitcasts.
2424 if (Op0->getType()->isPointerTy())
2425 return false;
2426 // Count every uses of both Op0 and Op1 in a subtract.
2427 // Each time Op0 is the first operand, count -1: swapping is bad, the
2428 // subtract has already the same layout as the compare.
2429 // Each time Op0 is the second operand, count +1: swapping is good, the
Alp Tokercb402912014-01-24 17:20:08 +00002430 // subtract has a different layout as the compare.
Quentin Colombet5ab55552013-09-09 20:56:48 +00002431 // At the end, if the benefit is greater than 0, Op0 should come second to
2432 // expose more CSE opportunities.
2433 int GlobalSwapBenefits = 0;
Chandler Carruthcdf47882014-03-09 03:16:01 +00002434 for (const User *U : Op0->users()) {
2435 const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(U);
Quentin Colombet5ab55552013-09-09 20:56:48 +00002436 if (!BinOp || BinOp->getOpcode() != Instruction::Sub)
2437 continue;
2438 // If Op0 is the first argument, this is not beneficial to swap the
2439 // arguments.
2440 int LocalSwapBenefits = -1;
2441 unsigned Op1Idx = 1;
2442 if (BinOp->getOperand(Op1Idx) == Op0) {
2443 Op1Idx = 0;
2444 LocalSwapBenefits = 1;
2445 }
2446 if (BinOp->getOperand(Op1Idx) != Op1)
2447 continue;
2448 GlobalSwapBenefits += LocalSwapBenefits;
2449 }
2450 return GlobalSwapBenefits > 0;
2451}
2452
Chris Lattner2188e402010-01-04 07:37:31 +00002453Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
2454 bool Changed = false;
Chris Lattner9306ffa2010-02-01 19:54:45 +00002455 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Quentin Colombet5ab55552013-09-09 20:56:48 +00002456 unsigned Op0Cplxity = getComplexity(Op0);
2457 unsigned Op1Cplxity = getComplexity(Op1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002458
Chris Lattner2188e402010-01-04 07:37:31 +00002459 /// Orders the operands of the compare so that they are listed from most
2460 /// complex to least complex. This puts constants before unary operators,
2461 /// before binary operators.
Quentin Colombet5ab55552013-09-09 20:56:48 +00002462 if (Op0Cplxity < Op1Cplxity ||
2463 (Op0Cplxity == Op1Cplxity &&
2464 swapMayExposeCSEOpportunities(Op0, Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00002465 I.swapOperands();
Chris Lattner9306ffa2010-02-01 19:54:45 +00002466 std::swap(Op0, Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00002467 Changed = true;
2468 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002469
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002470 if (Value *V = SimplifyICmpInst(I.getPredicate(), Op0, Op1, DL))
Chris Lattner2188e402010-01-04 07:37:31 +00002471 return ReplaceInstUsesWith(I, V);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002472
Pete Cooperbc5c5242011-12-01 03:58:40 +00002473 // comparing -val or val with non-zero is the same as just comparing val
Pete Cooperfdddc272011-12-01 19:13:26 +00002474 // ie, abs(val) != 0 -> val != 0
Pete Cooperbc5c5242011-12-01 03:58:40 +00002475 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero()))
2476 {
Pete Cooperfdddc272011-12-01 19:13:26 +00002477 Value *Cond, *SelectTrue, *SelectFalse;
2478 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
Pete Cooperbc5c5242011-12-01 03:58:40 +00002479 m_Value(SelectFalse)))) {
Pete Cooperfdddc272011-12-01 19:13:26 +00002480 if (Value *V = dyn_castNegVal(SelectTrue)) {
2481 if (V == SelectFalse)
2482 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
2483 }
2484 else if (Value *V = dyn_castNegVal(SelectFalse)) {
2485 if (V == SelectTrue)
2486 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
Pete Cooperbc5c5242011-12-01 03:58:40 +00002487 }
2488 }
2489 }
2490
Chris Lattner229907c2011-07-18 04:54:35 +00002491 Type *Ty = Op0->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00002492
2493 // icmp's with boolean values can always be turned into bitwise operations
Duncan Sands9dff9be2010-02-15 16:12:20 +00002494 if (Ty->isIntegerTy(1)) {
Chris Lattner2188e402010-01-04 07:37:31 +00002495 switch (I.getPredicate()) {
2496 default: llvm_unreachable("Invalid icmp instruction!");
2497 case ICmpInst::ICMP_EQ: { // icmp eq i1 A, B -> ~(A^B)
2498 Value *Xor = Builder->CreateXor(Op0, Op1, I.getName()+"tmp");
2499 return BinaryOperator::CreateNot(Xor);
2500 }
2501 case ICmpInst::ICMP_NE: // icmp eq i1 A, B -> A^B
2502 return BinaryOperator::CreateXor(Op0, Op1);
2503
2504 case ICmpInst::ICMP_UGT:
2505 std::swap(Op0, Op1); // Change icmp ugt -> icmp ult
2506 // FALL THROUGH
2507 case ICmpInst::ICMP_ULT:{ // icmp ult i1 A, B -> ~A & B
2508 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2509 return BinaryOperator::CreateAnd(Not, Op1);
2510 }
2511 case ICmpInst::ICMP_SGT:
2512 std::swap(Op0, Op1); // Change icmp sgt -> icmp slt
2513 // FALL THROUGH
2514 case ICmpInst::ICMP_SLT: { // icmp slt i1 A, B -> A & ~B
2515 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2516 return BinaryOperator::CreateAnd(Not, Op0);
2517 }
2518 case ICmpInst::ICMP_UGE:
2519 std::swap(Op0, Op1); // Change icmp uge -> icmp ule
2520 // FALL THROUGH
2521 case ICmpInst::ICMP_ULE: { // icmp ule i1 A, B -> ~A | B
2522 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2523 return BinaryOperator::CreateOr(Not, Op1);
2524 }
2525 case ICmpInst::ICMP_SGE:
2526 std::swap(Op0, Op1); // Change icmp sge -> icmp sle
2527 // FALL THROUGH
2528 case ICmpInst::ICMP_SLE: { // icmp sle i1 A, B -> A | ~B
2529 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2530 return BinaryOperator::CreateOr(Not, Op0);
2531 }
2532 }
2533 }
2534
2535 unsigned BitWidth = 0;
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002536 if (Ty->isIntOrIntVectorTy())
Chris Lattner2188e402010-01-04 07:37:31 +00002537 BitWidth = Ty->getScalarSizeInBits();
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002538 else if (DL) // Pointers require DL info to get their size.
2539 BitWidth = DL->getTypeSizeInBits(Ty->getScalarType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00002540
Chris Lattner2188e402010-01-04 07:37:31 +00002541 bool isSignBit = false;
2542
2543 // See if we are doing a comparison with a constant.
2544 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Craig Topperf40110f2014-04-25 05:29:35 +00002545 Value *A = nullptr, *B = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002546
Owen Anderson1294ea72010-12-17 18:08:00 +00002547 // Match the following pattern, which is a common idiom when writing
2548 // overflow-safe integer arithmetic function. The source performs an
2549 // addition in wider type, and explicitly checks for overflow using
2550 // comparisons against INT_MIN and INT_MAX. Simplify this by using the
2551 // sadd_with_overflow intrinsic.
Chris Lattneree61c1d2010-12-19 17:52:50 +00002552 //
2553 // TODO: This could probably be generalized to handle other overflow-safe
Jim Grosbach129c52a2011-09-30 18:09:53 +00002554 // operations if we worked out the formulas to compute the appropriate
Owen Anderson1294ea72010-12-17 18:08:00 +00002555 // magic constants.
Jim Grosbach129c52a2011-09-30 18:09:53 +00002556 //
Chris Lattneree61c1d2010-12-19 17:52:50 +00002557 // sum = a + b
2558 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8
Owen Anderson1294ea72010-12-17 18:08:00 +00002559 {
Chris Lattneree61c1d2010-12-19 17:52:50 +00002560 ConstantInt *CI2; // I = icmp ugt (add (add A, B), CI2), CI
Owen Anderson1294ea72010-12-17 18:08:00 +00002561 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
Chris Lattneree61c1d2010-12-19 17:52:50 +00002562 match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
Chris Lattnerce2995a2010-12-19 18:38:44 +00002563 if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this))
Chris Lattneree61c1d2010-12-19 17:52:50 +00002564 return Res;
Owen Anderson1294ea72010-12-17 18:08:00 +00002565 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002566
Chris Lattner2188e402010-01-04 07:37:31 +00002567 // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B)
2568 if (I.isEquality() && CI->isZero() &&
2569 match(Op0, m_Sub(m_Value(A), m_Value(B)))) {
2570 // (icmp cond A B) if cond is equality
2571 return new ICmpInst(I.getPredicate(), A, B);
2572 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002573
Chris Lattner2188e402010-01-04 07:37:31 +00002574 // If we have an icmp le or icmp ge instruction, turn it into the
2575 // appropriate icmp lt or icmp gt instruction. This allows us to rely on
2576 // them being folded in the code below. The SimplifyICmpInst code has
2577 // already handled the edge cases for us, so we just assert on them.
2578 switch (I.getPredicate()) {
2579 default: break;
2580 case ICmpInst::ICMP_ULE:
2581 assert(!CI->isMaxValue(false)); // A <=u MAX -> TRUE
2582 return new ICmpInst(ICmpInst::ICMP_ULT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002583 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00002584 case ICmpInst::ICMP_SLE:
2585 assert(!CI->isMaxValue(true)); // A <=s MAX -> TRUE
2586 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002587 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00002588 case ICmpInst::ICMP_UGE:
Nick Lewycky6b4454192011-02-28 06:20:05 +00002589 assert(!CI->isMinValue(false)); // A >=u MIN -> TRUE
Chris Lattner2188e402010-01-04 07:37:31 +00002590 return new ICmpInst(ICmpInst::ICMP_UGT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002591 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002592 case ICmpInst::ICMP_SGE:
Nick Lewycky6b4454192011-02-28 06:20:05 +00002593 assert(!CI->isMinValue(true)); // A >=s MIN -> TRUE
Chris Lattner2188e402010-01-04 07:37:31 +00002594 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002595 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002596 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002597
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00002598 // (icmp eq/ne (ashr/lshr const2, A), const1)
2599 if (I.isEquality()) {
2600 ConstantInt *CI2;
2601 if (match(Op0, m_AShr(m_ConstantInt(CI2), m_Value(A))) ||
2602 match(Op0, m_LShr(m_ConstantInt(CI2), m_Value(A)))) {
2603 return FoldICmpCstShrCst(I, Op0, A, CI, CI2);
2604 }
2605 }
2606
Chris Lattner2188e402010-01-04 07:37:31 +00002607 // If this comparison is a normal comparison, it demands all
2608 // bits, if it is a sign bit comparison, it only demands the sign bit.
2609 bool UnusedBit;
2610 isSignBit = isSignBitCheck(I.getPredicate(), CI, UnusedBit);
2611 }
2612
2613 // See if we can fold the comparison based on range information we can get
2614 // by checking whether bits are known to be zero or one in the input.
2615 if (BitWidth != 0) {
2616 APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0);
2617 APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0);
2618
2619 if (SimplifyDemandedBits(I.getOperandUse(0),
Owen Andersond490c2d2011-01-11 00:36:45 +00002620 DemandedBitsLHSMask(I, BitWidth, isSignBit),
Chris Lattner2188e402010-01-04 07:37:31 +00002621 Op0KnownZero, Op0KnownOne, 0))
2622 return &I;
2623 if (SimplifyDemandedBits(I.getOperandUse(1),
2624 APInt::getAllOnesValue(BitWidth),
2625 Op1KnownZero, Op1KnownOne, 0))
2626 return &I;
2627
2628 // Given the known and unknown bits, compute a range that the LHS could be
2629 // in. Compute the Min, Max and RHS values based on the known bits. For the
2630 // EQ and NE we use unsigned values.
2631 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
2632 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
2633 if (I.isSigned()) {
2634 ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2635 Op0Min, Op0Max);
2636 ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2637 Op1Min, Op1Max);
2638 } else {
2639 ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2640 Op0Min, Op0Max);
2641 ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2642 Op1Min, Op1Max);
2643 }
2644
2645 // If Min and Max are known to be the same, then SimplifyDemandedBits
2646 // figured out that the LHS is a constant. Just constant fold this now so
2647 // that code below can assume that Min != Max.
2648 if (!isa<Constant>(Op0) && Op0Min == Op0Max)
2649 return new ICmpInst(I.getPredicate(),
Nick Lewycky92db8e82011-03-06 03:36:19 +00002650 ConstantInt::get(Op0->getType(), Op0Min), Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00002651 if (!isa<Constant>(Op1) && Op1Min == Op1Max)
2652 return new ICmpInst(I.getPredicate(), Op0,
Nick Lewycky92db8e82011-03-06 03:36:19 +00002653 ConstantInt::get(Op1->getType(), Op1Min));
Chris Lattner2188e402010-01-04 07:37:31 +00002654
2655 // Based on the range information we know about the LHS, see if we can
Nick Lewycky6b4454192011-02-28 06:20:05 +00002656 // simplify this comparison. For example, (x&4) < 8 is always true.
Chris Lattner2188e402010-01-04 07:37:31 +00002657 switch (I.getPredicate()) {
2658 default: llvm_unreachable("Unknown icmp opcode!");
Chris Lattnerf7e89612010-11-21 06:44:42 +00002659 case ICmpInst::ICMP_EQ: {
Chris Lattner2188e402010-01-04 07:37:31 +00002660 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Nick Lewycky92db8e82011-03-06 03:36:19 +00002661 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Jim Grosbach129c52a2011-09-30 18:09:53 +00002662
Chris Lattnerf7e89612010-11-21 06:44:42 +00002663 // If all bits are known zero except for one, then we know at most one
2664 // bit is set. If the comparison is against zero, then this is a check
2665 // to see if *that* bit is set.
2666 APInt Op0KnownZeroInverted = ~Op0KnownZero;
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002667 if (~Op1KnownZero == 0) {
Chris Lattnerf7e89612010-11-21 06:44:42 +00002668 // If the LHS is an AND with the same constant, look through it.
Craig Topperf40110f2014-04-25 05:29:35 +00002669 Value *LHS = nullptr;
2670 ConstantInt *LHSC = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002671 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2672 LHSC->getValue() != Op0KnownZeroInverted)
2673 LHS = Op0;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002674
Chris Lattnerf7e89612010-11-21 06:44:42 +00002675 // 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 +00002676 // then turn "((1 << x)&8) == 0" into "x != 3".
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002677 // or turn "((1 << x)&7) == 0" into "x > 2".
Craig Topperf40110f2014-04-25 05:29:35 +00002678 Value *X = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002679 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002680 APInt ValToCheck = Op0KnownZeroInverted;
2681 if (ValToCheck.isPowerOf2()) {
2682 unsigned CmpVal = ValToCheck.countTrailingZeros();
2683 return new ICmpInst(ICmpInst::ICMP_NE, X,
2684 ConstantInt::get(X->getType(), CmpVal));
2685 } else if ((++ValToCheck).isPowerOf2()) {
2686 unsigned CmpVal = ValToCheck.countTrailingZeros() - 1;
2687 return new ICmpInst(ICmpInst::ICMP_UGT, X,
2688 ConstantInt::get(X->getType(), CmpVal));
2689 }
Chris Lattnerf7e89612010-11-21 06:44:42 +00002690 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002691
Chris Lattnerf7e89612010-11-21 06:44:42 +00002692 // 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 +00002693 // then turn "((8 >>u x)&1) == 0" into "x != 3".
Chris Lattner98457102011-02-10 05:23:05 +00002694 const APInt *CI;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002695 if (Op0KnownZeroInverted == 1 &&
Chris Lattner98457102011-02-10 05:23:05 +00002696 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattnere5afa152010-11-23 02:42:04 +00002697 return new ICmpInst(ICmpInst::ICMP_NE, X,
Chris Lattner98457102011-02-10 05:23:05 +00002698 ConstantInt::get(X->getType(),
2699 CI->countTrailingZeros()));
Chris Lattnerf7e89612010-11-21 06:44:42 +00002700 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002701
Chris Lattner2188e402010-01-04 07:37:31 +00002702 break;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002703 }
2704 case ICmpInst::ICMP_NE: {
Chris Lattner2188e402010-01-04 07:37:31 +00002705 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Nick Lewycky92db8e82011-03-06 03:36:19 +00002706 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Jim Grosbach129c52a2011-09-30 18:09:53 +00002707
Chris Lattnerf7e89612010-11-21 06:44:42 +00002708 // If all bits are known zero except for one, then we know at most one
2709 // bit is set. If the comparison is against zero, then this is a check
2710 // to see if *that* bit is set.
2711 APInt Op0KnownZeroInverted = ~Op0KnownZero;
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002712 if (~Op1KnownZero == 0) {
Chris Lattnerf7e89612010-11-21 06:44:42 +00002713 // If the LHS is an AND with the same constant, look through it.
Craig Topperf40110f2014-04-25 05:29:35 +00002714 Value *LHS = nullptr;
2715 ConstantInt *LHSC = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002716 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2717 LHSC->getValue() != Op0KnownZeroInverted)
2718 LHS = Op0;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002719
Chris Lattnerf7e89612010-11-21 06:44:42 +00002720 // 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 +00002721 // then turn "((1 << x)&8) != 0" into "x == 3".
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002722 // or turn "((1 << x)&7) != 0" into "x < 3".
Craig Topperf40110f2014-04-25 05:29:35 +00002723 Value *X = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002724 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002725 APInt ValToCheck = Op0KnownZeroInverted;
2726 if (ValToCheck.isPowerOf2()) {
2727 unsigned CmpVal = ValToCheck.countTrailingZeros();
2728 return new ICmpInst(ICmpInst::ICMP_EQ, X,
2729 ConstantInt::get(X->getType(), CmpVal));
2730 } else if ((++ValToCheck).isPowerOf2()) {
2731 unsigned CmpVal = ValToCheck.countTrailingZeros();
2732 return new ICmpInst(ICmpInst::ICMP_ULT, X,
2733 ConstantInt::get(X->getType(), CmpVal));
2734 }
Chris Lattnerf7e89612010-11-21 06:44:42 +00002735 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002736
Chris Lattnerf7e89612010-11-21 06:44:42 +00002737 // 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 +00002738 // then turn "((8 >>u x)&1) != 0" into "x == 3".
Chris Lattner98457102011-02-10 05:23:05 +00002739 const APInt *CI;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002740 if (Op0KnownZeroInverted == 1 &&
Chris Lattner98457102011-02-10 05:23:05 +00002741 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattnere5afa152010-11-23 02:42:04 +00002742 return new ICmpInst(ICmpInst::ICMP_EQ, X,
Chris Lattner98457102011-02-10 05:23:05 +00002743 ConstantInt::get(X->getType(),
2744 CI->countTrailingZeros()));
Chris Lattnerf7e89612010-11-21 06:44:42 +00002745 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002746
Chris Lattner2188e402010-01-04 07:37:31 +00002747 break;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002748 }
Chris Lattner2188e402010-01-04 07:37:31 +00002749 case ICmpInst::ICMP_ULT:
2750 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002751 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002752 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002753 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002754 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
2755 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2756 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2757 if (Op1Max == Op0Min+1) // A <u C -> A == C-1 if min(A)+1 == C
2758 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002759 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002760
2761 // (x <u 2147483648) -> (x >s -1) -> true if sign bit clear
2762 if (CI->isMinValue(true))
2763 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
2764 Constant::getAllOnesValue(Op0->getType()));
2765 }
2766 break;
2767 case ICmpInst::ICMP_UGT:
2768 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002769 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002770 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002771 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002772
2773 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
2774 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2775 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2776 if (Op1Min == Op0Max-1) // A >u C -> A == C+1 if max(a)-1 == C
2777 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002778 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00002779
2780 // (x >u 2147483647) -> (x <s 0) -> true if sign bit set
2781 if (CI->isMaxValue(true))
2782 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
2783 Constant::getNullValue(Op0->getType()));
2784 }
2785 break;
2786 case ICmpInst::ICMP_SLT:
2787 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002788 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002789 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002790 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002791 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
2792 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2793 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2794 if (Op1Max == Op0Min+1) // A <s C -> A == C-1 if min(A)+1 == C
2795 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002796 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002797 }
2798 break;
2799 case ICmpInst::ICMP_SGT:
2800 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002801 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002802 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002803 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002804
2805 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
2806 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2807 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2808 if (Op1Min == Op0Max-1) // A >s C -> A == C+1 if max(A)-1 == C
2809 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002810 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00002811 }
2812 break;
2813 case ICmpInst::ICMP_SGE:
2814 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
2815 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002816 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002817 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002818 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002819 break;
2820 case ICmpInst::ICMP_SLE:
2821 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
2822 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002823 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002824 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002825 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002826 break;
2827 case ICmpInst::ICMP_UGE:
2828 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
2829 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002830 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002831 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002832 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002833 break;
2834 case ICmpInst::ICMP_ULE:
2835 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
2836 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002837 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002838 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002839 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002840 break;
2841 }
2842
2843 // Turn a signed comparison into an unsigned one if both operands
2844 // are known to have the same sign.
2845 if (I.isSigned() &&
2846 ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) ||
2847 (Op0KnownOne.isNegative() && Op1KnownOne.isNegative())))
2848 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
2849 }
2850
2851 // Test if the ICmpInst instruction is used exclusively by a select as
2852 // part of a minimum or maximum operation. If so, refrain from doing
2853 // any other folding. This helps out other analyses which understand
2854 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
2855 // and CodeGen. And in this case, at least one of the comparison
2856 // operands has at least one user besides the compare (the select),
2857 // which would often largely negate the benefit of folding anyway.
2858 if (I.hasOneUse())
Chandler Carruthcdf47882014-03-09 03:16:01 +00002859 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
Chris Lattner2188e402010-01-04 07:37:31 +00002860 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
2861 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
Craig Topperf40110f2014-04-25 05:29:35 +00002862 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002863
2864 // See if we are doing a comparison between a constant and an instruction that
2865 // can be folded into the comparison.
2866 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00002867 // Since the RHS is a ConstantInt (CI), if the left hand side is an
2868 // instruction, see if that instruction also has constants so that the
2869 // instruction can be folded into the icmp
Chris Lattner2188e402010-01-04 07:37:31 +00002870 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2871 if (Instruction *Res = visitICmpInstWithInstAndIntCst(I, LHSI, CI))
2872 return Res;
2873 }
2874
2875 // Handle icmp with constant (but not simple integer constant) RHS
2876 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
2877 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2878 switch (LHSI->getOpcode()) {
2879 case Instruction::GetElementPtr:
2880 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
2881 if (RHSC->isNullValue() &&
2882 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
2883 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2884 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2885 break;
2886 case Instruction::PHI:
2887 // Only fold icmp into the PHI if the phi and icmp are in the same
2888 // block. If in the same block, we're encouraging jump threading. If
2889 // not, we are just pessimizing the code by making an i1 phi.
2890 if (LHSI->getParent() == I.getParent())
Chris Lattnerea7131a2011-01-16 05:14:26 +00002891 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner2188e402010-01-04 07:37:31 +00002892 return NV;
2893 break;
2894 case Instruction::Select: {
2895 // If either operand of the select is a constant, we can fold the
2896 // comparison into the select arms, which will cause one to be
2897 // constant folded and the select turned into a bitwise or.
Craig Topperf40110f2014-04-25 05:29:35 +00002898 Value *Op1 = nullptr, *Op2 = nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002899 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1)))
2900 Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2901 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2)))
2902 Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2903
2904 // We only want to perform this transformation if it will not lead to
2905 // additional code. This is true if either both sides of the select
2906 // fold to a constant (in which case the icmp is replaced with a select
2907 // which will usually simplify) or this is the only user of the
2908 // select (in which case we are trading a select+icmp for a simpler
2909 // select+icmp).
2910 if ((Op1 && Op2) || (LHSI->hasOneUse() && (Op1 || Op2))) {
2911 if (!Op1)
2912 Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1),
2913 RHSC, I.getName());
2914 if (!Op2)
2915 Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2),
2916 RHSC, I.getName());
2917 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
2918 }
2919 break;
2920 }
Chris Lattner2188e402010-01-04 07:37:31 +00002921 case Instruction::IntToPtr:
2922 // icmp pred inttoptr(X), null -> icmp pred X, 0
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002923 if (RHSC->isNullValue() && DL &&
2924 DL->getIntPtrType(RHSC->getType()) ==
Chris Lattner2188e402010-01-04 07:37:31 +00002925 LHSI->getOperand(0)->getType())
2926 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2927 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2928 break;
2929
2930 case Instruction::Load:
2931 // Try to optimize things like "A[i] > 4" to index computations.
2932 if (GetElementPtrInst *GEP =
2933 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
2934 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
2935 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
2936 !cast<LoadInst>(LHSI)->isVolatile())
2937 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
2938 return Res;
2939 }
2940 break;
2941 }
2942 }
2943
2944 // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
2945 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
2946 if (Instruction *NI = FoldGEPICmp(GEP, Op1, I.getPredicate(), I))
2947 return NI;
2948 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
2949 if (Instruction *NI = FoldGEPICmp(GEP, Op0,
2950 ICmpInst::getSwappedPredicate(I.getPredicate()), I))
2951 return NI;
2952
2953 // Test to see if the operands of the icmp are casted versions of other
2954 // values. If the ptr->ptr cast can be stripped off both arguments, we do so
2955 // now.
2956 if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00002957 if (Op0->getType()->isPointerTy() &&
2958 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00002959 // We keep moving the cast from the left operand over to the right
2960 // operand, where it can often be eliminated completely.
2961 Op0 = CI->getOperand(0);
2962
2963 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
2964 // so eliminate it as well.
2965 if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
2966 Op1 = CI2->getOperand(0);
2967
2968 // If Op1 is a constant, we can fold the cast into the constant.
2969 if (Op0->getType() != Op1->getType()) {
2970 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
2971 Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
2972 } else {
2973 // Otherwise, cast the RHS right before the icmp
2974 Op1 = Builder->CreateBitCast(Op1, Op0->getType());
2975 }
2976 }
2977 return new ICmpInst(I.getPredicate(), Op0, Op1);
2978 }
2979 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002980
Chris Lattner2188e402010-01-04 07:37:31 +00002981 if (isa<CastInst>(Op0)) {
2982 // Handle the special case of: icmp (cast bool to X), <cst>
2983 // This comes up when you have code like
2984 // int X = A < B;
2985 // if (X) ...
2986 // For generality, we handle any zero-extension of any operand comparison
2987 // with a constant or another cast from the same type.
2988 if (isa<Constant>(Op1) || isa<CastInst>(Op1))
2989 if (Instruction *R = visitICmpInstWithCastAndCast(I))
2990 return R;
2991 }
Chris Lattner2188e402010-01-04 07:37:31 +00002992
Duncan Sandse5220012011-02-17 07:46:37 +00002993 // Special logic for binary operators.
2994 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
2995 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
2996 if (BO0 || BO1) {
2997 CmpInst::Predicate Pred = I.getPredicate();
2998 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
2999 if (BO0 && isa<OverflowingBinaryOperator>(BO0))
3000 NoOp0WrapProblem = ICmpInst::isEquality(Pred) ||
3001 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
3002 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
3003 if (BO1 && isa<OverflowingBinaryOperator>(BO1))
3004 NoOp1WrapProblem = ICmpInst::isEquality(Pred) ||
3005 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
3006 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
3007
3008 // Analyze the case when either Op0 or Op1 is an add instruction.
3009 // 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 +00003010 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
Duncan Sandse5220012011-02-17 07:46:37 +00003011 if (BO0 && BO0->getOpcode() == Instruction::Add)
3012 A = BO0->getOperand(0), B = BO0->getOperand(1);
3013 if (BO1 && BO1->getOpcode() == Instruction::Add)
3014 C = BO1->getOperand(0), D = BO1->getOperand(1);
3015
3016 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
3017 if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
3018 return new ICmpInst(Pred, A == Op1 ? B : A,
3019 Constant::getNullValue(Op1->getType()));
3020
3021 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
3022 if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
3023 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
3024 C == Op0 ? D : C);
3025
Duncan Sands84653b32011-02-18 16:25:37 +00003026 // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandse5220012011-02-17 07:46:37 +00003027 if (A && C && (A == C || A == D || B == C || B == D) &&
3028 NoOp0WrapProblem && NoOp1WrapProblem &&
3029 // Try not to increase register pressure.
3030 BO0->hasOneUse() && BO1->hasOneUse()) {
3031 // Determine Y and Z in the form icmp (X+Y), (X+Z).
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003032 Value *Y, *Z;
3033 if (A == C) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003034 // C + B == C + D -> B == D
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003035 Y = B;
3036 Z = D;
3037 } else if (A == D) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003038 // D + B == C + D -> B == C
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003039 Y = B;
3040 Z = C;
3041 } else if (B == C) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003042 // A + C == C + D -> A == D
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003043 Y = A;
3044 Z = D;
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003045 } else {
3046 assert(B == D);
3047 // A + D == C + D -> A == C
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003048 Y = A;
3049 Z = C;
3050 }
Duncan Sandse5220012011-02-17 07:46:37 +00003051 return new ICmpInst(Pred, Y, Z);
3052 }
3053
David Majnemerb81cd632013-04-11 20:05:46 +00003054 // icmp slt (X + -1), Y -> icmp sle X, Y
3055 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
3056 match(B, m_AllOnes()))
3057 return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
3058
3059 // icmp sge (X + -1), Y -> icmp sgt X, Y
3060 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
3061 match(B, m_AllOnes()))
3062 return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
3063
3064 // icmp sle (X + 1), Y -> icmp slt X, Y
3065 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE &&
3066 match(B, m_One()))
3067 return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
3068
3069 // icmp sgt (X + 1), Y -> icmp sge X, Y
3070 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT &&
3071 match(B, m_One()))
3072 return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
3073
3074 // if C1 has greater magnitude than C2:
3075 // icmp (X + C1), (Y + C2) -> icmp (X + C3), Y
3076 // s.t. C3 = C1 - C2
3077 //
3078 // if C2 has greater magnitude than C1:
3079 // icmp (X + C1), (Y + C2) -> icmp X, (Y + C3)
3080 // s.t. C3 = C2 - C1
3081 if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
3082 (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
3083 if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
3084 if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
3085 const APInt &AP1 = C1->getValue();
3086 const APInt &AP2 = C2->getValue();
3087 if (AP1.isNegative() == AP2.isNegative()) {
3088 APInt AP1Abs = C1->getValue().abs();
3089 APInt AP2Abs = C2->getValue().abs();
3090 if (AP1Abs.uge(AP2Abs)) {
3091 ConstantInt *C3 = Builder->getInt(AP1 - AP2);
3092 Value *NewAdd = Builder->CreateNSWAdd(A, C3);
3093 return new ICmpInst(Pred, NewAdd, C);
3094 } else {
3095 ConstantInt *C3 = Builder->getInt(AP2 - AP1);
3096 Value *NewAdd = Builder->CreateNSWAdd(C, C3);
3097 return new ICmpInst(Pred, A, NewAdd);
3098 }
3099 }
3100 }
3101
3102
Duncan Sandse5220012011-02-17 07:46:37 +00003103 // Analyze the case when either Op0 or Op1 is a sub instruction.
3104 // 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 +00003105 A = nullptr; B = nullptr; C = nullptr; D = nullptr;
Duncan Sandse5220012011-02-17 07:46:37 +00003106 if (BO0 && BO0->getOpcode() == Instruction::Sub)
3107 A = BO0->getOperand(0), B = BO0->getOperand(1);
3108 if (BO1 && BO1->getOpcode() == Instruction::Sub)
3109 C = BO1->getOperand(0), D = BO1->getOperand(1);
3110
Duncan Sands84653b32011-02-18 16:25:37 +00003111 // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
3112 if (A == Op1 && NoOp0WrapProblem)
3113 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
3114
3115 // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
3116 if (C == Op0 && NoOp1WrapProblem)
3117 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
3118
3119 // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandse5220012011-02-17 07:46:37 +00003120 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
3121 // Try not to increase register pressure.
3122 BO0->hasOneUse() && BO1->hasOneUse())
3123 return new ICmpInst(Pred, A, C);
3124
Duncan Sands84653b32011-02-18 16:25:37 +00003125 // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
3126 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
3127 // Try not to increase register pressure.
3128 BO0->hasOneUse() && BO1->hasOneUse())
3129 return new ICmpInst(Pred, D, B);
3130
David Majnemer186c9422014-05-15 00:02:20 +00003131 // icmp (0-X) < cst --> x > -cst
3132 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) {
3133 Value *X;
3134 if (match(BO0, m_Neg(m_Value(X))))
3135 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
3136 if (!RHSC->isMinValue(/*isSigned=*/true))
3137 return new ICmpInst(I.getSwappedPredicate(), X,
3138 ConstantExpr::getNeg(RHSC));
3139 }
3140
Craig Topperf40110f2014-04-25 05:29:35 +00003141 BinaryOperator *SRem = nullptr;
Nick Lewyckyafc80982011-03-08 06:29:47 +00003142 // icmp (srem X, Y), Y
Nick Lewycky25cc3382011-03-05 04:28:48 +00003143 if (BO0 && BO0->getOpcode() == Instruction::SRem &&
3144 Op1 == BO0->getOperand(1))
3145 SRem = BO0;
Nick Lewyckyafc80982011-03-08 06:29:47 +00003146 // icmp Y, (srem X, Y)
Nick Lewycky25cc3382011-03-05 04:28:48 +00003147 else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
3148 Op0 == BO1->getOperand(1))
3149 SRem = BO1;
3150 if (SRem) {
3151 // We don't check hasOneUse to avoid increasing register pressure because
3152 // the value we use is the same value this instruction was already using.
3153 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
3154 default: break;
3155 case ICmpInst::ICMP_EQ:
Nick Lewycky92db8e82011-03-06 03:36:19 +00003156 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Nick Lewycky25cc3382011-03-05 04:28:48 +00003157 case ICmpInst::ICMP_NE:
Nick Lewycky92db8e82011-03-06 03:36:19 +00003158 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Nick Lewycky25cc3382011-03-05 04:28:48 +00003159 case ICmpInst::ICMP_SGT:
3160 case ICmpInst::ICMP_SGE:
3161 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
3162 Constant::getAllOnesValue(SRem->getType()));
3163 case ICmpInst::ICMP_SLT:
3164 case ICmpInst::ICMP_SLE:
3165 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
3166 Constant::getNullValue(SRem->getType()));
3167 }
3168 }
3169
Duncan Sandse5220012011-02-17 07:46:37 +00003170 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() &&
3171 BO0->hasOneUse() && BO1->hasOneUse() &&
3172 BO0->getOperand(1) == BO1->getOperand(1)) {
3173 switch (BO0->getOpcode()) {
3174 default: break;
3175 case Instruction::Add:
3176 case Instruction::Sub:
3177 case Instruction::Xor:
3178 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
3179 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3180 BO1->getOperand(0));
3181 // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b
3182 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
3183 if (CI->getValue().isSignBit()) {
3184 ICmpInst::Predicate Pred = I.isSigned()
3185 ? I.getUnsignedPredicate()
3186 : I.getSignedPredicate();
3187 return new ICmpInst(Pred, BO0->getOperand(0),
3188 BO1->getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +00003189 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003190
Chris Lattnerb1a15122011-07-15 06:08:15 +00003191 if (CI->isMaxValue(true)) {
Duncan Sandse5220012011-02-17 07:46:37 +00003192 ICmpInst::Predicate Pred = I.isSigned()
3193 ? I.getUnsignedPredicate()
3194 : I.getSignedPredicate();
3195 Pred = I.getSwappedPredicate(Pred);
3196 return new ICmpInst(Pred, BO0->getOperand(0),
3197 BO1->getOperand(0));
3198 }
Chris Lattner2188e402010-01-04 07:37:31 +00003199 }
Duncan Sandse5220012011-02-17 07:46:37 +00003200 break;
3201 case Instruction::Mul:
3202 if (!I.isEquality())
3203 break;
3204
3205 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
3206 // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask
3207 // Mask = -1 >> count-trailing-zeros(Cst).
3208 if (!CI->isZero() && !CI->isOne()) {
3209 const APInt &AP = CI->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003210 ConstantInt *Mask = ConstantInt::get(I.getContext(),
Duncan Sandse5220012011-02-17 07:46:37 +00003211 APInt::getLowBitsSet(AP.getBitWidth(),
3212 AP.getBitWidth() -
3213 AP.countTrailingZeros()));
3214 Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask);
3215 Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask);
3216 return new ICmpInst(I.getPredicate(), And1, And2);
3217 }
3218 }
3219 break;
Nick Lewycky9719a712011-03-05 05:19:11 +00003220 case Instruction::UDiv:
3221 case Instruction::LShr:
3222 if (I.isSigned())
3223 break;
3224 // fall-through
3225 case Instruction::SDiv:
3226 case Instruction::AShr:
Eli Friedman8a20e662011-05-05 21:59:18 +00003227 if (!BO0->isExact() || !BO1->isExact())
Nick Lewycky9719a712011-03-05 05:19:11 +00003228 break;
3229 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3230 BO1->getOperand(0));
3231 case Instruction::Shl: {
3232 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
3233 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
3234 if (!NUW && !NSW)
3235 break;
3236 if (!NSW && I.isSigned())
3237 break;
3238 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3239 BO1->getOperand(0));
3240 }
Chris Lattner2188e402010-01-04 07:37:31 +00003241 }
3242 }
3243 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003244
Chris Lattner2188e402010-01-04 07:37:31 +00003245 { Value *A, *B;
David Majnemer1a08acc2013-04-12 17:25:07 +00003246 // Transform (A & ~B) == 0 --> (A & B) != 0
3247 // and (A & ~B) != 0 --> (A & B) == 0
3248 // if A is a power of 2.
3249 if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
3250 match(Op1, m_Zero()) && isKnownToBeAPowerOfTwo(A) && I.isEquality())
3251 return new ICmpInst(I.getInversePredicate(),
3252 Builder->CreateAnd(A, B),
3253 Op1);
3254
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00003255 // ~x < ~y --> y < x
3256 // ~x < cst --> ~cst < x
3257 if (match(Op0, m_Not(m_Value(A)))) {
3258 if (match(Op1, m_Not(m_Value(B))))
3259 return new ICmpInst(I.getPredicate(), B, A);
Chris Lattner497459d2011-01-15 05:42:47 +00003260 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00003261 return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A);
3262 }
Chris Lattner5e0c0c72010-12-19 19:37:52 +00003263
3264 // (a+b) <u a --> llvm.uadd.with.overflow.
3265 // (a+b) <u b --> llvm.uadd.with.overflow.
3266 if (I.getPredicate() == ICmpInst::ICMP_ULT &&
Jim Grosbach129c52a2011-09-30 18:09:53 +00003267 match(Op0, m_Add(m_Value(A), m_Value(B))) &&
Chris Lattner5e0c0c72010-12-19 19:37:52 +00003268 (Op1 == A || Op1 == B))
3269 if (Instruction *R = ProcessUAddIdiom(I, Op0, *this))
3270 return R;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003271
Chris Lattner5e0c0c72010-12-19 19:37:52 +00003272 // a >u (a+b) --> llvm.uadd.with.overflow.
3273 // b >u (a+b) --> llvm.uadd.with.overflow.
3274 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
3275 match(Op1, m_Add(m_Value(A), m_Value(B))) &&
3276 (Op0 == A || Op0 == B))
3277 if (Instruction *R = ProcessUAddIdiom(I, Op1, *this))
3278 return R;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003279
3280 // (zext a) * (zext b) --> llvm.umul.with.overflow.
3281 if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
3282 if (Instruction *R = ProcessUMulZExtIdiom(I, Op0, Op1, *this))
3283 return R;
3284 }
3285 if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
3286 if (Instruction *R = ProcessUMulZExtIdiom(I, Op1, Op0, *this))
3287 return R;
3288 }
Chris Lattner2188e402010-01-04 07:37:31 +00003289 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003290
Chris Lattner2188e402010-01-04 07:37:31 +00003291 if (I.isEquality()) {
3292 Value *A, *B, *C, *D;
Duncan Sands84653b32011-02-18 16:25:37 +00003293
Chris Lattner2188e402010-01-04 07:37:31 +00003294 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
3295 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0
3296 Value *OtherVal = A == Op1 ? B : A;
3297 return new ICmpInst(I.getPredicate(), OtherVal,
3298 Constant::getNullValue(A->getType()));
3299 }
3300
3301 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
3302 // A^c1 == C^c2 --> A == C^(c1^c2)
3303 ConstantInt *C1, *C2;
3304 if (match(B, m_ConstantInt(C1)) &&
3305 match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) {
Jakub Staszakbddea112013-06-06 20:18:46 +00003306 Constant *NC = Builder->getInt(C1->getValue() ^ C2->getValue());
Benjamin Kramer547b6c52011-09-27 20:39:19 +00003307 Value *Xor = Builder->CreateXor(C, NC);
Chris Lattner2188e402010-01-04 07:37:31 +00003308 return new ICmpInst(I.getPredicate(), A, Xor);
3309 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003310
Chris Lattner2188e402010-01-04 07:37:31 +00003311 // A^B == A^D -> B == D
3312 if (A == C) return new ICmpInst(I.getPredicate(), B, D);
3313 if (A == D) return new ICmpInst(I.getPredicate(), B, C);
3314 if (B == C) return new ICmpInst(I.getPredicate(), A, D);
3315 if (B == D) return new ICmpInst(I.getPredicate(), A, C);
3316 }
3317 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003318
Chris Lattner2188e402010-01-04 07:37:31 +00003319 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
3320 (A == Op0 || B == Op0)) {
3321 // A == (A^B) -> B == 0
3322 Value *OtherVal = A == Op0 ? B : A;
3323 return new ICmpInst(I.getPredicate(), OtherVal,
3324 Constant::getNullValue(A->getType()));
3325 }
3326
Chris Lattner2188e402010-01-04 07:37:31 +00003327 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
Jim Grosbach129c52a2011-09-30 18:09:53 +00003328 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
Chris Lattner31b106d2011-04-26 20:02:45 +00003329 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
Craig Topperf40110f2014-04-25 05:29:35 +00003330 Value *X = nullptr, *Y = nullptr, *Z = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003331
Chris Lattner2188e402010-01-04 07:37:31 +00003332 if (A == C) {
3333 X = B; Y = D; Z = A;
3334 } else if (A == D) {
3335 X = B; Y = C; Z = A;
3336 } else if (B == C) {
3337 X = A; Y = D; Z = B;
3338 } else if (B == D) {
3339 X = A; Y = C; Z = B;
3340 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003341
Chris Lattner2188e402010-01-04 07:37:31 +00003342 if (X) { // Build (X^Y) & Z
Benjamin Kramer547b6c52011-09-27 20:39:19 +00003343 Op1 = Builder->CreateXor(X, Y);
3344 Op1 = Builder->CreateAnd(Op1, Z);
Chris Lattner2188e402010-01-04 07:37:31 +00003345 I.setOperand(0, Op1);
3346 I.setOperand(1, Constant::getNullValue(Op1->getType()));
3347 return &I;
3348 }
3349 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003350
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00003351 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
Benjamin Kramer21501452012-06-11 08:01:25 +00003352 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B)
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00003353 ConstantInt *Cst1;
Benjamin Kramer21501452012-06-11 08:01:25 +00003354 if ((Op0->hasOneUse() &&
3355 match(Op0, m_ZExt(m_Value(A))) &&
3356 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
3357 (Op1->hasOneUse() &&
3358 match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
3359 match(Op1, m_ZExt(m_Value(A))))) {
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00003360 APInt Pow2 = Cst1->getValue() + 1;
3361 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
3362 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
3363 return new ICmpInst(I.getPredicate(), A,
3364 Builder->CreateTrunc(B, A->getType()));
3365 }
3366
Benjamin Kramer03f3e242013-11-16 16:00:48 +00003367 // (A >> C) == (B >> C) --> (A^B) u< (1 << C)
3368 // For lshr and ashr pairs.
3369 if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) &&
3370 match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) ||
3371 (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) &&
3372 match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) {
3373 unsigned TypeBits = Cst1->getBitWidth();
3374 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
3375 if (ShAmt < TypeBits && ShAmt != 0) {
3376 ICmpInst::Predicate Pred = I.getPredicate() == ICmpInst::ICMP_NE
3377 ? ICmpInst::ICMP_UGE
3378 : ICmpInst::ICMP_ULT;
3379 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
3380 APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt);
3381 return new ICmpInst(Pred, Xor, Builder->getInt(CmpVal));
3382 }
3383 }
3384
Chris Lattner1b06c712011-04-26 20:18:20 +00003385 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
3386 // "icmp (and X, mask), cst"
3387 uint64_t ShAmt = 0;
Chris Lattner1b06c712011-04-26 20:18:20 +00003388 if (Op0->hasOneUse() &&
3389 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A),
3390 m_ConstantInt(ShAmt))))) &&
3391 match(Op1, m_ConstantInt(Cst1)) &&
3392 // Only do this when A has multiple uses. This is most important to do
3393 // when it exposes other optimizations.
3394 !A->hasOneUse()) {
3395 unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003396
Chris Lattner1b06c712011-04-26 20:18:20 +00003397 if (ShAmt < ASize) {
3398 APInt MaskV =
3399 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
3400 MaskV <<= ShAmt;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003401
Chris Lattner1b06c712011-04-26 20:18:20 +00003402 APInt CmpV = Cst1->getValue().zext(ASize);
3403 CmpV <<= ShAmt;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003404
Chris Lattner1b06c712011-04-26 20:18:20 +00003405 Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV));
3406 return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV));
3407 }
3408 }
Chris Lattner2188e402010-01-04 07:37:31 +00003409 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003410
Chris Lattner2188e402010-01-04 07:37:31 +00003411 {
3412 Value *X; ConstantInt *Cst;
3413 // icmp X+Cst, X
3414 if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X)
Benjamin Kramer0e2d1622013-09-20 22:12:42 +00003415 return FoldICmpAddOpCst(I, X, Cst, I.getPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00003416
3417 // icmp X, X+Cst
3418 if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X)
Benjamin Kramer0e2d1622013-09-20 22:12:42 +00003419 return FoldICmpAddOpCst(I, X, Cst, I.getSwappedPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00003420 }
Craig Topperf40110f2014-04-25 05:29:35 +00003421 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003422}
3423
Chris Lattner2188e402010-01-04 07:37:31 +00003424/// FoldFCmp_IntToFP_Cst - Fold fcmp ([us]itofp x, cst) if possible.
3425///
3426Instruction *InstCombiner::FoldFCmp_IntToFP_Cst(FCmpInst &I,
3427 Instruction *LHSI,
3428 Constant *RHSC) {
Craig Topperf40110f2014-04-25 05:29:35 +00003429 if (!isa<ConstantFP>(RHSC)) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003430 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003431
Chris Lattner2188e402010-01-04 07:37:31 +00003432 // Get the width of the mantissa. We don't want to hack on conversions that
3433 // might lose information from the integer, e.g. "i64 -> float"
3434 int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
Craig Topperf40110f2014-04-25 05:29:35 +00003435 if (MantissaWidth == -1) return nullptr; // Unknown.
Jim Grosbach129c52a2011-09-30 18:09:53 +00003436
Chris Lattner2188e402010-01-04 07:37:31 +00003437 // Check to see that the input is converted from an integer type that is small
3438 // enough that preserves all bits. TODO: check here for "known" sign bits.
3439 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
3440 unsigned InputSize = LHSI->getOperand(0)->getType()->getScalarSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003441
Chris Lattner2188e402010-01-04 07:37:31 +00003442 // If this is a uitofp instruction, we need an extra bit to hold the sign.
3443 bool LHSUnsigned = isa<UIToFPInst>(LHSI);
3444 if (LHSUnsigned)
3445 ++InputSize;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003446
Chris Lattner2188e402010-01-04 07:37:31 +00003447 // If the conversion would lose info, don't hack on this.
3448 if ((int)InputSize > MantissaWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00003449 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003450
Chris Lattner2188e402010-01-04 07:37:31 +00003451 // Otherwise, we can potentially simplify the comparison. We know that it
3452 // will always come through as an integer value and we know the constant is
3453 // not a NAN (it would have been previously simplified).
3454 assert(!RHS.isNaN() && "NaN comparison not already folded!");
Jim Grosbach129c52a2011-09-30 18:09:53 +00003455
Chris Lattner2188e402010-01-04 07:37:31 +00003456 ICmpInst::Predicate Pred;
3457 switch (I.getPredicate()) {
3458 default: llvm_unreachable("Unexpected predicate!");
3459 case FCmpInst::FCMP_UEQ:
3460 case FCmpInst::FCMP_OEQ:
3461 Pred = ICmpInst::ICMP_EQ;
3462 break;
3463 case FCmpInst::FCMP_UGT:
3464 case FCmpInst::FCMP_OGT:
3465 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
3466 break;
3467 case FCmpInst::FCMP_UGE:
3468 case FCmpInst::FCMP_OGE:
3469 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
3470 break;
3471 case FCmpInst::FCMP_ULT:
3472 case FCmpInst::FCMP_OLT:
3473 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
3474 break;
3475 case FCmpInst::FCMP_ULE:
3476 case FCmpInst::FCMP_OLE:
3477 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
3478 break;
3479 case FCmpInst::FCMP_UNE:
3480 case FCmpInst::FCMP_ONE:
3481 Pred = ICmpInst::ICMP_NE;
3482 break;
3483 case FCmpInst::FCMP_ORD:
Jakub Staszakbddea112013-06-06 20:18:46 +00003484 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003485 case FCmpInst::FCMP_UNO:
Jakub Staszakbddea112013-06-06 20:18:46 +00003486 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003487 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003488
Chris Lattner229907c2011-07-18 04:54:35 +00003489 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00003490
Chris Lattner2188e402010-01-04 07:37:31 +00003491 // Now we know that the APFloat is a normal number, zero or inf.
Jim Grosbach129c52a2011-09-30 18:09:53 +00003492
Chris Lattner2188e402010-01-04 07:37:31 +00003493 // See if the FP constant is too large for the integer. For example,
3494 // comparing an i8 to 300.0.
3495 unsigned IntWidth = IntTy->getScalarSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003496
Chris Lattner2188e402010-01-04 07:37:31 +00003497 if (!LHSUnsigned) {
3498 // If the RHS value is > SignedMax, fold the comparison. This handles +INF
3499 // and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00003500 APFloat SMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00003501 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
3502 APFloat::rmNearestTiesToEven);
3503 if (SMax.compare(RHS) == APFloat::cmpLessThan) { // smax < 13123.0
3504 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT ||
3505 Pred == ICmpInst::ICMP_SLE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003506 return ReplaceInstUsesWith(I, Builder->getTrue());
3507 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003508 }
3509 } else {
3510 // If the RHS value is > UnsignedMax, fold the comparison. This handles
3511 // +INF and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00003512 APFloat UMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00003513 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
3514 APFloat::rmNearestTiesToEven);
3515 if (UMax.compare(RHS) == APFloat::cmpLessThan) { // umax < 13123.0
3516 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT ||
3517 Pred == ICmpInst::ICMP_ULE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003518 return ReplaceInstUsesWith(I, Builder->getTrue());
3519 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003520 }
3521 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003522
Chris Lattner2188e402010-01-04 07:37:31 +00003523 if (!LHSUnsigned) {
3524 // See if the RHS value is < SignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00003525 APFloat SMin(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00003526 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
3527 APFloat::rmNearestTiesToEven);
3528 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
3529 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
3530 Pred == ICmpInst::ICMP_SGE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003531 return ReplaceInstUsesWith(I, Builder->getTrue());
3532 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003533 }
Devang Patel698452b2012-02-13 23:05:18 +00003534 } else {
3535 // See if the RHS value is < UnsignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00003536 APFloat SMin(RHS.getSemantics());
Devang Patel698452b2012-02-13 23:05:18 +00003537 SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
3538 APFloat::rmNearestTiesToEven);
3539 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
3540 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
3541 Pred == ICmpInst::ICMP_UGE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003542 return ReplaceInstUsesWith(I, Builder->getTrue());
3543 return ReplaceInstUsesWith(I, Builder->getFalse());
Devang Patel698452b2012-02-13 23:05:18 +00003544 }
Chris Lattner2188e402010-01-04 07:37:31 +00003545 }
3546
3547 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
3548 // [0, UMAX], but it may still be fractional. See if it is fractional by
3549 // casting the FP value to the integer value and back, checking for equality.
3550 // Don't do this for zero, because -0.0 is not fractional.
3551 Constant *RHSInt = LHSUnsigned
3552 ? ConstantExpr::getFPToUI(RHSC, IntTy)
3553 : ConstantExpr::getFPToSI(RHSC, IntTy);
3554 if (!RHS.isZero()) {
3555 bool Equal = LHSUnsigned
3556 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
3557 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
3558 if (!Equal) {
3559 // If we had a comparison against a fractional value, we have to adjust
3560 // the compare predicate and sometimes the value. RHSC is rounded towards
3561 // zero at this point.
3562 switch (Pred) {
3563 default: llvm_unreachable("Unexpected integer comparison!");
3564 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true
Jakub Staszakbddea112013-06-06 20:18:46 +00003565 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003566 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false
Jakub Staszakbddea112013-06-06 20:18:46 +00003567 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003568 case ICmpInst::ICMP_ULE:
3569 // (float)int <= 4.4 --> int <= 4
3570 // (float)int <= -4.4 --> false
3571 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003572 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003573 break;
3574 case ICmpInst::ICMP_SLE:
3575 // (float)int <= 4.4 --> int <= 4
3576 // (float)int <= -4.4 --> int < -4
3577 if (RHS.isNegative())
3578 Pred = ICmpInst::ICMP_SLT;
3579 break;
3580 case ICmpInst::ICMP_ULT:
3581 // (float)int < -4.4 --> false
3582 // (float)int < 4.4 --> int <= 4
3583 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003584 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003585 Pred = ICmpInst::ICMP_ULE;
3586 break;
3587 case ICmpInst::ICMP_SLT:
3588 // (float)int < -4.4 --> int < -4
3589 // (float)int < 4.4 --> int <= 4
3590 if (!RHS.isNegative())
3591 Pred = ICmpInst::ICMP_SLE;
3592 break;
3593 case ICmpInst::ICMP_UGT:
3594 // (float)int > 4.4 --> int > 4
3595 // (float)int > -4.4 --> true
3596 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003597 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003598 break;
3599 case ICmpInst::ICMP_SGT:
3600 // (float)int > 4.4 --> int > 4
3601 // (float)int > -4.4 --> int >= -4
3602 if (RHS.isNegative())
3603 Pred = ICmpInst::ICMP_SGE;
3604 break;
3605 case ICmpInst::ICMP_UGE:
3606 // (float)int >= -4.4 --> true
3607 // (float)int >= 4.4 --> int > 4
Bob Wilson61f3ad52012-08-07 22:35:16 +00003608 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003609 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003610 Pred = ICmpInst::ICMP_UGT;
3611 break;
3612 case ICmpInst::ICMP_SGE:
3613 // (float)int >= -4.4 --> int >= -4
3614 // (float)int >= 4.4 --> int > 4
3615 if (!RHS.isNegative())
3616 Pred = ICmpInst::ICMP_SGT;
3617 break;
3618 }
3619 }
3620 }
3621
3622 // Lower this FP comparison into an appropriate integer version of the
3623 // comparison.
3624 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
3625}
3626
3627Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
3628 bool Changed = false;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003629
Chris Lattner2188e402010-01-04 07:37:31 +00003630 /// Orders the operands of the compare so that they are listed from most
3631 /// complex to least complex. This puts constants before unary operators,
3632 /// before binary operators.
3633 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
3634 I.swapOperands();
3635 Changed = true;
3636 }
3637
3638 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00003639
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003640 if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1, DL))
Chris Lattner2188e402010-01-04 07:37:31 +00003641 return ReplaceInstUsesWith(I, V);
3642
3643 // Simplify 'fcmp pred X, X'
3644 if (Op0 == Op1) {
3645 switch (I.getPredicate()) {
3646 default: llvm_unreachable("Unknown predicate!");
3647 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y)
3648 case FCmpInst::FCMP_ULT: // True if unordered or less than
3649 case FCmpInst::FCMP_UGT: // True if unordered or greater than
3650 case FCmpInst::FCMP_UNE: // True if unordered or not equal
3651 // Canonicalize these to be 'fcmp uno %X, 0.0'.
3652 I.setPredicate(FCmpInst::FCMP_UNO);
3653 I.setOperand(1, Constant::getNullValue(Op0->getType()));
3654 return &I;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003655
Chris Lattner2188e402010-01-04 07:37:31 +00003656 case FCmpInst::FCMP_ORD: // True if ordered (no nans)
3657 case FCmpInst::FCMP_OEQ: // True if ordered and equal
3658 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal
3659 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal
3660 // Canonicalize these to be 'fcmp ord %X, 0.0'.
3661 I.setPredicate(FCmpInst::FCMP_ORD);
3662 I.setOperand(1, Constant::getNullValue(Op0->getType()));
3663 return &I;
3664 }
3665 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003666
Chris Lattner2188e402010-01-04 07:37:31 +00003667 // Handle fcmp with constant RHS
3668 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
3669 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3670 switch (LHSI->getOpcode()) {
Benjamin Kramercbb18e92011-03-31 10:12:07 +00003671 case Instruction::FPExt: {
3672 // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
3673 FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
3674 ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
3675 if (!RHSF)
3676 break;
3677
3678 const fltSemantics *Sem;
3679 // FIXME: This shouldn't be here.
Dan Gohman518cda42011-12-17 00:04:22 +00003680 if (LHSExt->getSrcTy()->isHalfTy())
3681 Sem = &APFloat::IEEEhalf;
3682 else if (LHSExt->getSrcTy()->isFloatTy())
Benjamin Kramercbb18e92011-03-31 10:12:07 +00003683 Sem = &APFloat::IEEEsingle;
3684 else if (LHSExt->getSrcTy()->isDoubleTy())
3685 Sem = &APFloat::IEEEdouble;
3686 else if (LHSExt->getSrcTy()->isFP128Ty())
3687 Sem = &APFloat::IEEEquad;
3688 else if (LHSExt->getSrcTy()->isX86_FP80Ty())
3689 Sem = &APFloat::x87DoubleExtended;
Ulrich Weigand6a9bb512012-10-30 12:33:18 +00003690 else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
3691 Sem = &APFloat::PPCDoubleDouble;
Benjamin Kramercbb18e92011-03-31 10:12:07 +00003692 else
3693 break;
3694
3695 bool Lossy;
3696 APFloat F = RHSF->getValueAPF();
3697 F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
3698
Jim Grosbach24ff8342011-09-30 18:45:50 +00003699 // Avoid lossy conversions and denormals. Zero is a special case
3700 // that's OK to convert.
Jim Grosbach011dafb2011-09-30 19:58:46 +00003701 APFloat Fabs = F;
3702 Fabs.clearSign();
Benjamin Kramercbb18e92011-03-31 10:12:07 +00003703 if (!Lossy &&
Jim Grosbach011dafb2011-09-30 19:58:46 +00003704 ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
3705 APFloat::cmpLessThan) || Fabs.isZero()))
Jim Grosbach24ff8342011-09-30 18:45:50 +00003706
Benjamin Kramercbb18e92011-03-31 10:12:07 +00003707 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3708 ConstantFP::get(RHSC->getContext(), F));
3709 break;
3710 }
Chris Lattner2188e402010-01-04 07:37:31 +00003711 case Instruction::PHI:
3712 // Only fold fcmp into the PHI if the phi and fcmp are in the same
3713 // block. If in the same block, we're encouraging jump threading. If
3714 // not, we are just pessimizing the code by making an i1 phi.
3715 if (LHSI->getParent() == I.getParent())
Chris Lattnerea7131a2011-01-16 05:14:26 +00003716 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner2188e402010-01-04 07:37:31 +00003717 return NV;
3718 break;
3719 case Instruction::SIToFP:
3720 case Instruction::UIToFP:
3721 if (Instruction *NV = FoldFCmp_IntToFP_Cst(I, LHSI, RHSC))
3722 return NV;
3723 break;
Benjamin Kramera8c5d082011-03-31 10:12:15 +00003724 case Instruction::FSub: {
3725 // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
3726 Value *Op;
3727 if (match(LHSI, m_FNeg(m_Value(Op))))
3728 return new FCmpInst(I.getSwappedPredicate(), Op,
3729 ConstantExpr::getFNeg(RHSC));
3730 break;
3731 }
Dan Gohman94732022010-02-24 06:46:09 +00003732 case Instruction::Load:
3733 if (GetElementPtrInst *GEP =
3734 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3735 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3736 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3737 !cast<LoadInst>(LHSI)->isVolatile())
3738 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
3739 return Res;
3740 }
3741 break;
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00003742 case Instruction::Call: {
3743 CallInst *CI = cast<CallInst>(LHSI);
3744 LibFunc::Func Func;
3745 // Various optimization for fabs compared with zero.
Benjamin Kramer9d032422012-08-18 22:04:34 +00003746 if (RHSC->isNullValue() && CI->getCalledFunction() &&
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00003747 TLI->getLibFunc(CI->getCalledFunction()->getName(), Func) &&
3748 TLI->has(Func)) {
3749 if (Func == LibFunc::fabs || Func == LibFunc::fabsf ||
3750 Func == LibFunc::fabsl) {
3751 switch (I.getPredicate()) {
3752 default: break;
3753 // fabs(x) < 0 --> false
3754 case FCmpInst::FCMP_OLT:
3755 return ReplaceInstUsesWith(I, Builder->getFalse());
3756 // fabs(x) > 0 --> x != 0
3757 case FCmpInst::FCMP_OGT:
3758 return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0),
3759 RHSC);
3760 // fabs(x) <= 0 --> x == 0
3761 case FCmpInst::FCMP_OLE:
3762 return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0),
3763 RHSC);
3764 // fabs(x) >= 0 --> !isnan(x)
3765 case FCmpInst::FCMP_OGE:
3766 return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0),
3767 RHSC);
3768 // fabs(x) == 0 --> x == 0
3769 // fabs(x) != 0 --> x != 0
3770 case FCmpInst::FCMP_OEQ:
3771 case FCmpInst::FCMP_UEQ:
3772 case FCmpInst::FCMP_ONE:
3773 case FCmpInst::FCMP_UNE:
3774 return new FCmpInst(I.getPredicate(), CI->getArgOperand(0),
3775 RHSC);
3776 }
3777 }
3778 }
3779 }
Chris Lattner2188e402010-01-04 07:37:31 +00003780 }
Chris Lattner2188e402010-01-04 07:37:31 +00003781 }
3782
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00003783 // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
Benjamin Kramerd159d942011-03-31 10:12:22 +00003784 Value *X, *Y;
3785 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00003786 return new FCmpInst(I.getSwappedPredicate(), X, Y);
Benjamin Kramerd159d942011-03-31 10:12:22 +00003787
Benjamin Kramer2ccfbc82011-03-31 10:11:58 +00003788 // fcmp (fpext x), (fpext y) -> fcmp x, y
3789 if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
3790 if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
3791 if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
3792 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3793 RHSExt->getOperand(0));
3794
Craig Topperf40110f2014-04-25 05:29:35 +00003795 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003796}