blob: 2be03bd7f04359f57e290f09410d0b657f72002d [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 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
Chris Lattner0ab5e2c2011-04-15 05:18:47 +0000744 // so the values can never be equal. Similarly for all other "or equals"
Chris Lattner2188e402010-01-04 07:37:31 +0000745 // operators.
Jim Grosbach129c52a2011-09-30 18:09:53 +0000746
Chris Lattner8c92b572010-01-08 17:48:19 +0000747 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255
Chris Lattner2188e402010-01-04 07:37:31 +0000748 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253
749 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0
750 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
Jim Grosbach129c52a2011-09-30 18:09:53 +0000751 Value *R =
Chris Lattner8c92b572010-01-08 17:48:19 +0000752 ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI);
Chris Lattner2188e402010-01-04 07:37:31 +0000753 return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
754 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000755
Chris Lattner2188e402010-01-04 07:37:31 +0000756 // (X+1) >u X --> X <u (0-1) --> X != 255
757 // (X+2) >u X --> X <u (0-2) --> X <u 254
758 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0
Duncan Sandse5220012011-02-17 07:46:37 +0000759 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
Chris Lattner2188e402010-01-04 07:37:31 +0000760 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI));
Jim Grosbach129c52a2011-09-30 18:09:53 +0000761
Chris Lattner2188e402010-01-04 07:37:31 +0000762 unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits();
763 ConstantInt *SMax = ConstantInt::get(X->getContext(),
764 APInt::getSignedMaxValue(BitWidth));
765
766 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127
767 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125
768 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0
769 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1
770 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126
771 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127
Duncan Sandse5220012011-02-17 07:46:37 +0000772 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
Chris Lattner2188e402010-01-04 07:37:31 +0000773 return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI));
Jim Grosbach129c52a2011-09-30 18:09:53 +0000774
Chris Lattner2188e402010-01-04 07:37:31 +0000775 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127
776 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126
777 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
778 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
779 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126
780 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128
Jim Grosbach129c52a2011-09-30 18:09:53 +0000781
Chris Lattner2188e402010-01-04 07:37:31 +0000782 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
Jakub Staszakbddea112013-06-06 20:18:46 +0000783 Constant *C = Builder->getInt(CI->getValue()-1);
Chris Lattner2188e402010-01-04 07:37:31 +0000784 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C));
785}
786
787/// FoldICmpDivCst - Fold "icmp pred, ([su]div X, DivRHS), CmpRHS" where DivRHS
788/// and CmpRHS are both known to be integer constants.
789Instruction *InstCombiner::FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI,
790 ConstantInt *DivRHS) {
791 ConstantInt *CmpRHS = cast<ConstantInt>(ICI.getOperand(1));
792 const APInt &CmpRHSV = CmpRHS->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000793
794 // FIXME: If the operand types don't match the type of the divide
Chris Lattner2188e402010-01-04 07:37:31 +0000795 // then don't attempt this transform. The code below doesn't have the
796 // logic to deal with a signed divide and an unsigned compare (and
Jim Grosbach129c52a2011-09-30 18:09:53 +0000797 // vice versa). This is because (x /s C1) <s C2 produces different
Chris Lattner2188e402010-01-04 07:37:31 +0000798 // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even
Jim Grosbach129c52a2011-09-30 18:09:53 +0000799 // (x /u C1) <u C2. Simply casting the operands and result won't
800 // work. :( The if statement below tests that condition and bails
Chris Lattner98457102011-02-10 05:23:05 +0000801 // if it finds it.
Chris Lattner2188e402010-01-04 07:37:31 +0000802 bool DivIsSigned = DivI->getOpcode() == Instruction::SDiv;
803 if (!ICI.isEquality() && DivIsSigned != ICI.isSigned())
Craig Topperf40110f2014-04-25 05:29:35 +0000804 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +0000805 if (DivRHS->isZero())
Craig Topperf40110f2014-04-25 05:29:35 +0000806 return nullptr; // The ProdOV computation fails on divide by zero.
Chris Lattner2188e402010-01-04 07:37:31 +0000807 if (DivIsSigned && DivRHS->isAllOnesValue())
Craig Topperf40110f2014-04-25 05:29:35 +0000808 return nullptr; // The overflow computation also screws up here
Chris Lattner43273af2011-02-13 08:07:21 +0000809 if (DivRHS->isOne()) {
810 // This eliminates some funny cases with INT_MIN.
811 ICI.setOperand(0, DivI->getOperand(0)); // X/1 == X.
812 return &ICI;
813 }
Chris Lattner2188e402010-01-04 07:37:31 +0000814
815 // Compute Prod = CI * DivRHS. We are essentially solving an equation
Jim Grosbach129c52a2011-09-30 18:09:53 +0000816 // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and
817 // C2 (CI). By solving for X we can turn this into a range check
818 // instead of computing a divide.
Chris Lattner2188e402010-01-04 07:37:31 +0000819 Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS);
820
821 // Determine if the product overflows by seeing if the product is
822 // not equal to the divide. Make sure we do the same kind of divide
Jim Grosbach129c52a2011-09-30 18:09:53 +0000823 // as in the LHS instruction that we're folding.
Chris Lattner2188e402010-01-04 07:37:31 +0000824 bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) :
825 ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS;
826
827 // Get the ICmp opcode
828 ICmpInst::Predicate Pred = ICI.getPredicate();
829
Chris Lattner98457102011-02-10 05:23:05 +0000830 /// If the division is known to be exact, then there is no remainder from the
831 /// divide, so the covered range size is unit, otherwise it is the divisor.
832 ConstantInt *RangeSize = DivI->isExact() ? getOne(Prod) : DivRHS;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000833
Chris Lattner2188e402010-01-04 07:37:31 +0000834 // Figure out the interval that is being checked. For example, a comparison
Jim Grosbach129c52a2011-09-30 18:09:53 +0000835 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
Chris Lattner2188e402010-01-04 07:37:31 +0000836 // Compute this interval based on the constants involved and the signedness of
837 // the compare/divide. This computes a half-open interval, keeping track of
838 // whether either value in the interval overflows. After analysis each
839 // overflow variable is set to 0 if it's corresponding bound variable is valid
840 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
841 int LoOverflow = 0, HiOverflow = 0;
Craig Topperf40110f2014-04-25 05:29:35 +0000842 Constant *LoBound = nullptr, *HiBound = nullptr;
Chris Lattner98457102011-02-10 05:23:05 +0000843
Chris Lattner2188e402010-01-04 07:37:31 +0000844 if (!DivIsSigned) { // udiv
845 // e.g. X/5 op 3 --> [15, 20)
846 LoBound = Prod;
847 HiOverflow = LoOverflow = ProdOV;
Chris Lattner98457102011-02-10 05:23:05 +0000848 if (!HiOverflow) {
849 // If this is not an exact divide, then many values in the range collapse
850 // to the same result value.
851 HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false);
852 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000853
Chris Lattner2188e402010-01-04 07:37:31 +0000854 } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0.
855 if (CmpRHSV == 0) { // (X / pos) op 0
856 // Can't overflow. e.g. X/2 op 0 --> [-1, 2)
Chris Lattner98457102011-02-10 05:23:05 +0000857 LoBound = ConstantExpr::getNeg(SubOne(RangeSize));
858 HiBound = RangeSize;
Chris Lattner2188e402010-01-04 07:37:31 +0000859 } else if (CmpRHSV.isStrictlyPositive()) { // (X / pos) op pos
860 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20)
861 HiOverflow = LoOverflow = ProdOV;
862 if (!HiOverflow)
Chris Lattner98457102011-02-10 05:23:05 +0000863 HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true);
Chris Lattner2188e402010-01-04 07:37:31 +0000864 } else { // (X / pos) op neg
865 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14)
866 HiBound = AddOne(Prod);
867 LoOverflow = HiOverflow = ProdOV ? -1 : 0;
868 if (!LoOverflow) {
Chris Lattner98457102011-02-10 05:23:05 +0000869 ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +0000870 LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
Chris Lattner98457102011-02-10 05:23:05 +0000871 }
Chris Lattner2188e402010-01-04 07:37:31 +0000872 }
Chris Lattnerb1a15122011-07-15 06:08:15 +0000873 } else if (DivRHS->isNegative()) { // Divisor is < 0.
Chris Lattner98457102011-02-10 05:23:05 +0000874 if (DivI->isExact())
875 RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +0000876 if (CmpRHSV == 0) { // (X / neg) op 0
877 // e.g. X/-5 op 0 --> [-4, 5)
Chris Lattner98457102011-02-10 05:23:05 +0000878 LoBound = AddOne(RangeSize);
879 HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner2188e402010-01-04 07:37:31 +0000880 if (HiBound == DivRHS) { // -INTMIN = INTMIN
881 HiOverflow = 1; // [INTMIN+1, overflow)
Craig Topperf40110f2014-04-25 05:29:35 +0000882 HiBound = nullptr; // e.g. X/INTMIN = 0 --> X > INTMIN
Chris Lattner2188e402010-01-04 07:37:31 +0000883 }
884 } else if (CmpRHSV.isStrictlyPositive()) { // (X / neg) op pos
885 // e.g. X/-5 op 3 --> [-19, -14)
886 HiBound = AddOne(Prod);
887 HiOverflow = LoOverflow = ProdOV ? -1 : 0;
888 if (!LoOverflow)
Chris Lattner98457102011-02-10 05:23:05 +0000889 LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
Chris Lattner2188e402010-01-04 07:37:31 +0000890 } else { // (X / neg) op neg
891 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20)
892 LoOverflow = HiOverflow = ProdOV;
893 if (!HiOverflow)
Chris Lattner98457102011-02-10 05:23:05 +0000894 HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true);
Chris Lattner2188e402010-01-04 07:37:31 +0000895 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000896
Chris Lattner2188e402010-01-04 07:37:31 +0000897 // Dividing by a negative swaps the condition. LT <-> GT
898 Pred = ICmpInst::getSwappedPredicate(Pred);
899 }
900
901 Value *X = DivI->getOperand(0);
902 switch (Pred) {
903 default: llvm_unreachable("Unhandled icmp opcode!");
904 case ICmpInst::ICMP_EQ:
905 if (LoOverflow && HiOverflow)
Jakub Staszakbddea112013-06-06 20:18:46 +0000906 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner067459c2010-03-05 08:46:26 +0000907 if (HiOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000908 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
909 ICmpInst::ICMP_UGE, X, LoBound);
Chris Lattner067459c2010-03-05 08:46:26 +0000910 if (LoOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000911 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
912 ICmpInst::ICMP_ULT, X, HiBound);
Chris Lattner98457102011-02-10 05:23:05 +0000913 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
914 DivIsSigned, true));
Chris Lattner2188e402010-01-04 07:37:31 +0000915 case ICmpInst::ICMP_NE:
916 if (LoOverflow && HiOverflow)
Jakub Staszakbddea112013-06-06 20:18:46 +0000917 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner067459c2010-03-05 08:46:26 +0000918 if (HiOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000919 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
920 ICmpInst::ICMP_ULT, X, LoBound);
Chris Lattner067459c2010-03-05 08:46:26 +0000921 if (LoOverflow)
Chris Lattner2188e402010-01-04 07:37:31 +0000922 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
923 ICmpInst::ICMP_UGE, X, HiBound);
Chris Lattner067459c2010-03-05 08:46:26 +0000924 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
925 DivIsSigned, false));
Chris Lattner2188e402010-01-04 07:37:31 +0000926 case ICmpInst::ICMP_ULT:
927 case ICmpInst::ICMP_SLT:
928 if (LoOverflow == +1) // Low bound is greater than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000929 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +0000930 if (LoOverflow == -1) // Low bound is less than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000931 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +0000932 return new ICmpInst(Pred, X, LoBound);
933 case ICmpInst::ICMP_UGT:
934 case ICmpInst::ICMP_SGT:
935 if (HiOverflow == +1) // High bound greater than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000936 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner98457102011-02-10 05:23:05 +0000937 if (HiOverflow == -1) // High bound less than input range.
Jakub Staszakbddea112013-06-06 20:18:46 +0000938 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +0000939 if (Pred == ICmpInst::ICMP_UGT)
940 return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound);
Chris Lattner98457102011-02-10 05:23:05 +0000941 return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound);
Chris Lattner2188e402010-01-04 07:37:31 +0000942 }
943}
944
Chris Lattnerd369f572011-02-13 07:43:07 +0000945/// FoldICmpShrCst - Handle "icmp(([al]shr X, cst1), cst2)".
946Instruction *InstCombiner::FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *Shr,
947 ConstantInt *ShAmt) {
Chris Lattnerd369f572011-02-13 07:43:07 +0000948 const APInt &CmpRHSV = cast<ConstantInt>(ICI.getOperand(1))->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +0000949
Chris Lattnerd369f572011-02-13 07:43:07 +0000950 // Check that the shift amount is in range. If not, don't perform
951 // undefined shifts. When the shift is visited it will be
952 // simplified.
953 uint32_t TypeBits = CmpRHSV.getBitWidth();
954 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
Chris Lattner43273af2011-02-13 08:07:21 +0000955 if (ShAmtVal >= TypeBits || ShAmtVal == 0)
Craig Topperf40110f2014-04-25 05:29:35 +0000956 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000957
Chris Lattner43273af2011-02-13 08:07:21 +0000958 if (!ICI.isEquality()) {
959 // If we have an unsigned comparison and an ashr, we can't simplify this.
960 // Similarly for signed comparisons with lshr.
961 if (ICI.isSigned() != (Shr->getOpcode() == Instruction::AShr))
Craig Topperf40110f2014-04-25 05:29:35 +0000962 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000963
Eli Friedman865866e2011-05-25 23:26:20 +0000964 // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv
965 // by a power of 2. Since we already have logic to simplify these,
966 // transform to div and then simplify the resultant comparison.
Chris Lattner43273af2011-02-13 08:07:21 +0000967 if (Shr->getOpcode() == Instruction::AShr &&
Eli Friedman865866e2011-05-25 23:26:20 +0000968 (!Shr->isExact() || ShAmtVal == TypeBits - 1))
Craig Topperf40110f2014-04-25 05:29:35 +0000969 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000970
Chris Lattner43273af2011-02-13 08:07:21 +0000971 // Revisit the shift (to delete it).
972 Worklist.Add(Shr);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000973
Chris Lattner43273af2011-02-13 08:07:21 +0000974 Constant *DivCst =
975 ConstantInt::get(Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal));
Jim Grosbach129c52a2011-09-30 18:09:53 +0000976
Chris Lattner43273af2011-02-13 08:07:21 +0000977 Value *Tmp =
978 Shr->getOpcode() == Instruction::AShr ?
979 Builder->CreateSDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()) :
980 Builder->CreateUDiv(Shr->getOperand(0), DivCst, "", Shr->isExact());
Jim Grosbach129c52a2011-09-30 18:09:53 +0000981
Chris Lattner43273af2011-02-13 08:07:21 +0000982 ICI.setOperand(0, Tmp);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000983
Chris Lattner43273af2011-02-13 08:07:21 +0000984 // If the builder folded the binop, just return it.
985 BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp);
Craig Topperf40110f2014-04-25 05:29:35 +0000986 if (!TheDiv)
Chris Lattner43273af2011-02-13 08:07:21 +0000987 return &ICI;
Jim Grosbach129c52a2011-09-30 18:09:53 +0000988
Chris Lattner43273af2011-02-13 08:07:21 +0000989 // Otherwise, fold this div/compare.
990 assert(TheDiv->getOpcode() == Instruction::SDiv ||
991 TheDiv->getOpcode() == Instruction::UDiv);
Jim Grosbach129c52a2011-09-30 18:09:53 +0000992
Chris Lattner43273af2011-02-13 08:07:21 +0000993 Instruction *Res = FoldICmpDivCst(ICI, TheDiv, cast<ConstantInt>(DivCst));
994 assert(Res && "This div/cst should have folded!");
995 return Res;
996 }
Jim Grosbach129c52a2011-09-30 18:09:53 +0000997
998
Chris Lattnerd369f572011-02-13 07:43:07 +0000999 // If we are comparing against bits always shifted out, the
1000 // comparison cannot succeed.
1001 APInt Comp = CmpRHSV << ShAmtVal;
Jakub Staszakbddea112013-06-06 20:18:46 +00001002 ConstantInt *ShiftedCmpRHS = Builder->getInt(Comp);
Chris Lattnerd369f572011-02-13 07:43:07 +00001003 if (Shr->getOpcode() == Instruction::LShr)
1004 Comp = Comp.lshr(ShAmtVal);
1005 else
1006 Comp = Comp.ashr(ShAmtVal);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001007
Chris Lattnerd369f572011-02-13 07:43:07 +00001008 if (Comp != CmpRHSV) { // Comparing against a bit that we know is zero.
1009 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jakub Staszakbddea112013-06-06 20:18:46 +00001010 Constant *Cst = Builder->getInt1(IsICMP_NE);
Chris Lattnerd369f572011-02-13 07:43:07 +00001011 return ReplaceInstUsesWith(ICI, Cst);
1012 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001013
Chris Lattnerd369f572011-02-13 07:43:07 +00001014 // Otherwise, check to see if the bits shifted out are known to be zero.
1015 // If so, we can compare against the unshifted value:
1016 // (X & 4) >> 1 == 2 --> (X & 4) == 4.
Chris Lattner9bd7fdf2011-02-13 18:30:09 +00001017 if (Shr->hasOneUse() && Shr->isExact())
Chris Lattnerd369f572011-02-13 07:43:07 +00001018 return new ICmpInst(ICI.getPredicate(), Shr->getOperand(0), ShiftedCmpRHS);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001019
Chris Lattnerd369f572011-02-13 07:43:07 +00001020 if (Shr->hasOneUse()) {
1021 // Otherwise strength reduce the shift into an and.
1022 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
Jakub Staszakbddea112013-06-06 20:18:46 +00001023 Constant *Mask = Builder->getInt(Val);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001024
Chris Lattnerd369f572011-02-13 07:43:07 +00001025 Value *And = Builder->CreateAnd(Shr->getOperand(0),
1026 Mask, Shr->getName()+".mask");
1027 return new ICmpInst(ICI.getPredicate(), And, ShiftedCmpRHS);
1028 }
Craig Topperf40110f2014-04-25 05:29:35 +00001029 return nullptr;
Chris Lattnerd369f572011-02-13 07:43:07 +00001030}
1031
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001032/// FoldICmpCstShrCst - Handle "(icmp eq/ne (ashr/lshr const2, A), const1)" ->
1033/// (icmp eq/ne A, Log2(const2/const1)) ->
1034/// (icmp eq/ne A, Log2(const2) - Log2(const1)).
1035Instruction *InstCombiner::FoldICmpCstShrCst(ICmpInst &I, Value *Op, Value *A,
1036 ConstantInt *CI1,
1037 ConstantInt *CI2) {
1038 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1039
1040 auto getConstant = [&I, this](bool IsTrue) {
1041 if (I.getPredicate() == I.ICMP_NE)
1042 IsTrue = !IsTrue;
1043 return ReplaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
1044 };
1045
1046 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1047 if (I.getPredicate() == I.ICMP_NE)
1048 Pred = CmpInst::getInversePredicate(Pred);
1049 return new ICmpInst(Pred, LHS, RHS);
1050 };
1051
1052 APInt AP1 = CI1->getValue();
1053 APInt AP2 = CI2->getValue();
1054
David Majnemerd2056022014-10-21 19:51:55 +00001055 assert(AP2 != 0 && "Handled in InstSimplify");
1056 assert(!AP2.isAllOnesValue() && "Handled in InstSimplify");
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001057
David Majnemerd2056022014-10-21 19:51:55 +00001058 if (!AP1)
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001059 // 'A' must be large enough to shift out the highest set bit.
1060 return getICmp(I.ICMP_UGT, A,
1061 ConstantInt::get(A->getType(), AP2.logBase2()));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001062
David Majnemerd2056022014-10-21 19:51:55 +00001063 if (AP1 == AP2)
1064 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001065
1066 bool IsAShr = isa<AShrOperator>(Op);
David Majnemerd2056022014-10-21 19:51:55 +00001067 // If we are dealing with an arithmetic shift, both constants should agree in
1068 // sign. InstSimplify's SimplifyICmpInst range analysis is supposed to catch
1069 // the cases when they disagree.
1070 assert((!IsAShr || (AP1.isNegative() == AP2.isNegative() && AP1.sgt(AP2))) &&
1071 "Handled in InstSimplify");
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001072
1073 // Get the distance between the highest bit that's set.
Andrea Di Biagio5b92b492014-09-17 11:32:31 +00001074 int Shift;
David Majnemerd2056022014-10-21 19:51:55 +00001075 // Both the constants are negative, take their positive to calculate log.
1076 if (IsAShr && AP1.isNegative())
Andrea Di Biagio458a6692014-10-09 12:41:49 +00001077 // Get the ones' complement of AP2 and AP1 when computing the distance.
1078 Shift = (~AP2).logBase2() - (~AP1).logBase2();
Andrea Di Biagio5b92b492014-09-17 11:32:31 +00001079 else
1080 Shift = AP2.logBase2() - AP1.logBase2();
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001081
David Majnemerd2056022014-10-21 19:51:55 +00001082 if (Shift > 0) {
1083 if (IsAShr ? AP1 == AP2.ashr(Shift) : AP1 == AP2.lshr(Shift))
1084 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1085 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00001086 // Shifting const2 will never be equal to const1.
1087 return getConstant(false);
1088}
Chris Lattner2188e402010-01-04 07:37:31 +00001089
David Majnemer59939ac2014-10-19 08:23:08 +00001090/// FoldICmpCstShlCst - Handle "(icmp eq/ne (shl const2, A), const1)" ->
1091/// (icmp eq/ne A, TrailingZeros(const1) - TrailingZeros(const2)).
1092Instruction *InstCombiner::FoldICmpCstShlCst(ICmpInst &I, Value *Op, Value *A,
1093 ConstantInt *CI1,
1094 ConstantInt *CI2) {
1095 assert(I.isEquality() && "Cannot fold icmp gt/lt");
1096
1097 auto getConstant = [&I, this](bool IsTrue) {
1098 if (I.getPredicate() == I.ICMP_NE)
1099 IsTrue = !IsTrue;
1100 return ReplaceInstUsesWith(I, ConstantInt::get(I.getType(), IsTrue));
1101 };
1102
1103 auto getICmp = [&I](CmpInst::Predicate Pred, Value *LHS, Value *RHS) {
1104 if (I.getPredicate() == I.ICMP_NE)
1105 Pred = CmpInst::getInversePredicate(Pred);
1106 return new ICmpInst(Pred, LHS, RHS);
1107 };
1108
1109 APInt AP1 = CI1->getValue();
1110 APInt AP2 = CI2->getValue();
1111
1112 assert(AP2 != 0 && "Handled in InstSimplify");
1113
1114 unsigned AP2TrailingZeros = AP2.countTrailingZeros();
1115
1116 if (!AP1 && AP2TrailingZeros != 0)
1117 return getICmp(I.ICMP_UGE, A,
1118 ConstantInt::get(A->getType(), AP2.getBitWidth() - AP2TrailingZeros));
1119
1120 if (AP1 == AP2)
1121 return getICmp(I.ICMP_EQ, A, ConstantInt::getNullValue(A->getType()));
1122
1123 // Get the distance between the lowest bits that are set.
1124 int Shift = AP1.countTrailingZeros() - AP2TrailingZeros;
1125
1126 if (Shift > 0 && AP2.shl(Shift) == AP1)
1127 return getICmp(I.ICMP_EQ, A, ConstantInt::get(A->getType(), Shift));
1128
1129 // Shifting const2 will never be equal to const1.
1130 return getConstant(false);
1131}
1132
Chris Lattner2188e402010-01-04 07:37:31 +00001133/// visitICmpInstWithInstAndIntCst - Handle "icmp (instr, intcst)".
1134///
1135Instruction *InstCombiner::visitICmpInstWithInstAndIntCst(ICmpInst &ICI,
1136 Instruction *LHSI,
1137 ConstantInt *RHS) {
1138 const APInt &RHSV = RHS->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00001139
Chris Lattner2188e402010-01-04 07:37:31 +00001140 switch (LHSI->getOpcode()) {
1141 case Instruction::Trunc:
1142 if (ICI.isEquality() && LHSI->hasOneUse()) {
1143 // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1144 // of the high bits truncated out of x are known.
1145 unsigned DstBits = LHSI->getType()->getPrimitiveSizeInBits(),
1146 SrcBits = LHSI->getOperand(0)->getType()->getPrimitiveSizeInBits();
Chris Lattner2188e402010-01-04 07:37:31 +00001147 APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0);
Hal Finkel60db0582014-09-07 18:57:58 +00001148 computeKnownBits(LHSI->getOperand(0), KnownZero, KnownOne, 0, &ICI);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001149
Chris Lattner2188e402010-01-04 07:37:31 +00001150 // If all the high bits are known, we can do this xform.
1151 if ((KnownZero|KnownOne).countLeadingOnes() >= SrcBits-DstBits) {
1152 // Pull in the high bits from known-ones set.
Jay Foad583abbc2010-12-07 08:25:19 +00001153 APInt NewRHS = RHS->getValue().zext(SrcBits);
Eli Friedmane0a64d82012-05-11 01:32:59 +00001154 NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits-DstBits);
Chris Lattner2188e402010-01-04 07:37:31 +00001155 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001156 Builder->getInt(NewRHS));
Chris Lattner2188e402010-01-04 07:37:31 +00001157 }
1158 }
1159 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001160
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001161 case Instruction::Xor: // (icmp pred (xor X, XorCst), CI)
1162 if (ConstantInt *XorCst = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00001163 // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1164 // fold the xor.
1165 if ((ICI.getPredicate() == ICmpInst::ICMP_SLT && RHSV == 0) ||
1166 (ICI.getPredicate() == ICmpInst::ICMP_SGT && RHSV.isAllOnesValue())) {
1167 Value *CompareVal = LHSI->getOperand(0);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001168
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001169 // If the sign bit of the XorCst is not set, there is no change to
Chris Lattner2188e402010-01-04 07:37:31 +00001170 // the operation, just stop using the Xor.
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001171 if (!XorCst->isNegative()) {
Chris Lattner2188e402010-01-04 07:37:31 +00001172 ICI.setOperand(0, CompareVal);
1173 Worklist.Add(LHSI);
1174 return &ICI;
1175 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001176
Chris Lattner2188e402010-01-04 07:37:31 +00001177 // Was the old condition true if the operand is positive?
1178 bool isTrueIfPositive = ICI.getPredicate() == ICmpInst::ICMP_SGT;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001179
Chris Lattner2188e402010-01-04 07:37:31 +00001180 // If so, the new one isn't.
1181 isTrueIfPositive ^= true;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001182
Chris Lattner2188e402010-01-04 07:37:31 +00001183 if (isTrueIfPositive)
1184 return new ICmpInst(ICmpInst::ICMP_SGT, CompareVal,
1185 SubOne(RHS));
1186 else
1187 return new ICmpInst(ICmpInst::ICMP_SLT, CompareVal,
1188 AddOne(RHS));
1189 }
1190
1191 if (LHSI->hasOneUse()) {
1192 // (icmp u/s (xor A SignBit), C) -> (icmp s/u A, (xor C SignBit))
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001193 if (!ICI.isEquality() && XorCst->getValue().isSignBit()) {
1194 const APInt &SignBit = XorCst->getValue();
Chris Lattner2188e402010-01-04 07:37:31 +00001195 ICmpInst::Predicate Pred = ICI.isSigned()
1196 ? ICI.getUnsignedPredicate()
1197 : ICI.getSignedPredicate();
1198 return new ICmpInst(Pred, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001199 Builder->getInt(RHSV ^ SignBit));
Chris Lattner2188e402010-01-04 07:37:31 +00001200 }
1201
1202 // (icmp u/s (xor A ~SignBit), C) -> (icmp s/u (xor C ~SignBit), A)
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001203 if (!ICI.isEquality() && XorCst->isMaxValue(true)) {
1204 const APInt &NotSignBit = XorCst->getValue();
Chris Lattner2188e402010-01-04 07:37:31 +00001205 ICmpInst::Predicate Pred = ICI.isSigned()
1206 ? ICI.getUnsignedPredicate()
1207 : ICI.getSignedPredicate();
1208 Pred = ICI.getSwappedPredicate(Pred);
1209 return new ICmpInst(Pred, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001210 Builder->getInt(RHSV ^ NotSignBit));
Chris Lattner2188e402010-01-04 07:37:31 +00001211 }
1212 }
David Majnemer72d76272013-07-09 09:20:58 +00001213
1214 // (icmp ugt (xor X, C), ~C) -> (icmp ult X, C)
1215 // iff -C is a power of 2
1216 if (ICI.getPredicate() == ICmpInst::ICMP_UGT &&
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001217 XorCst->getValue() == ~RHSV && (RHSV + 1).isPowerOf2())
1218 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0), XorCst);
David Majnemer72d76272013-07-09 09:20:58 +00001219
1220 // (icmp ult (xor X, C), -C) -> (icmp uge X, C)
1221 // iff -C is a power of 2
1222 if (ICI.getPredicate() == ICmpInst::ICMP_ULT &&
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001223 XorCst->getValue() == -RHSV && RHSV.isPowerOf2())
1224 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0), XorCst);
Chris Lattner2188e402010-01-04 07:37:31 +00001225 }
1226 break;
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001227 case Instruction::And: // (icmp pred (and X, AndCst), RHS)
Chris Lattner2188e402010-01-04 07:37:31 +00001228 if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) &&
1229 LHSI->getOperand(0)->hasOneUse()) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001230 ConstantInt *AndCst = cast<ConstantInt>(LHSI->getOperand(1));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001231
Chris Lattner2188e402010-01-04 07:37:31 +00001232 // If the LHS is an AND of a truncating cast, we can widen the
1233 // and/compare to be the input width without changing the value
1234 // produced, eliminating a cast.
1235 if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) {
1236 // We can do this transformation if either the AND constant does not
Jim Grosbach129c52a2011-09-30 18:09:53 +00001237 // have its sign bit set or if it is an equality comparison.
Chris Lattner2188e402010-01-04 07:37:31 +00001238 // Extending a relational comparison when we're checking the sign
1239 // bit would not work.
Benjamin Kramer35159c12011-06-12 22:47:53 +00001240 if (ICI.isEquality() ||
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001241 (!AndCst->isNegative() && RHSV.isNonNegative())) {
Benjamin Kramer35159c12011-06-12 22:47:53 +00001242 Value *NewAnd =
Chris Lattner2188e402010-01-04 07:37:31 +00001243 Builder->CreateAnd(Cast->getOperand(0),
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001244 ConstantExpr::getZExt(AndCst, Cast->getSrcTy()));
Benjamin Kramer35159c12011-06-12 22:47:53 +00001245 NewAnd->takeName(LHSI);
Chris Lattner2188e402010-01-04 07:37:31 +00001246 return new ICmpInst(ICI.getPredicate(), NewAnd,
Benjamin Kramer35159c12011-06-12 22:47:53 +00001247 ConstantExpr::getZExt(RHS, Cast->getSrcTy()));
Chris Lattner2188e402010-01-04 07:37:31 +00001248 }
1249 }
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001250
1251 // If the LHS is an AND of a zext, and we have an equality compare, we can
1252 // shrink the and/compare to the smaller type, eliminating the cast.
1253 if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) {
Chris Lattner229907c2011-07-18 04:54:35 +00001254 IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy());
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001255 // Make sure we don't compare the upper bits, SimplifyDemandedBits
1256 // should fold the icmp to true/false in that case.
1257 if (ICI.isEquality() && RHSV.getActiveBits() <= Ty->getBitWidth()) {
1258 Value *NewAnd =
1259 Builder->CreateAnd(Cast->getOperand(0),
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001260 ConstantExpr::getTrunc(AndCst, Ty));
Benjamin Kramer91f914c2011-06-12 22:48:00 +00001261 NewAnd->takeName(LHSI);
1262 return new ICmpInst(ICI.getPredicate(), NewAnd,
1263 ConstantExpr::getTrunc(RHS, Ty));
1264 }
1265 }
1266
Chris Lattner2188e402010-01-04 07:37:31 +00001267 // If this is: (X >> C1) & C2 != C3 (where any shift and any compare
1268 // could exist), turn it into (X & (C2 << C1)) != (C3 << C1). This
1269 // happens a LOT in code produced by the C front-end, for bitfield
1270 // access.
1271 BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0));
1272 if (Shift && !Shift->isShift())
Craig Topperf40110f2014-04-25 05:29:35 +00001273 Shift = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001274
Chris Lattner2188e402010-01-04 07:37:31 +00001275 ConstantInt *ShAmt;
Craig Topperf40110f2014-04-25 05:29:35 +00001276 ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001277
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001278 // This seemingly simple opportunity to fold away a shift turns out to
1279 // be rather complicated. See PR17827
1280 // ( http://llvm.org/bugs/show_bug.cgi?id=17827 ) for details.
Chris Lattner2188e402010-01-04 07:37:31 +00001281 if (ShAmt) {
Kay Tiong Khoo5389f742013-12-02 18:43:59 +00001282 bool CanFold = false;
1283 unsigned ShiftOpcode = Shift->getOpcode();
1284 if (ShiftOpcode == Instruction::AShr) {
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001285 // There may be some constraints that make this possible,
1286 // but nothing simple has been discovered yet.
1287 CanFold = false;
1288 } else if (ShiftOpcode == Instruction::Shl) {
1289 // For a left shift, we can fold if the comparison is not signed.
1290 // We can also fold a signed comparison if the mask value and
1291 // comparison value are not negative. These constraints may not be
1292 // obvious, but we can prove that they are correct using an SMT
Kay Tiong Khooe37d5202013-12-19 18:35:54 +00001293 // solver.
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001294 if (!ICI.isSigned() || (!AndCst->isNegative() && !RHS->isNegative()))
Chris Lattner2188e402010-01-04 07:37:31 +00001295 CanFold = true;
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001296 } else if (ShiftOpcode == Instruction::LShr) {
1297 // For a logical right shift, we can fold if the comparison is not
1298 // signed. We can also fold a signed comparison if the shifted mask
1299 // value and the shifted comparison value are not negative.
1300 // These constraints may not be obvious, but we can prove that they
Kay Tiong Khooe37d5202013-12-19 18:35:54 +00001301 // are correct using an SMT solver.
Kay Tiong Khooa570b5a2013-12-19 18:07:17 +00001302 if (!ICI.isSigned())
1303 CanFold = true;
1304 else {
1305 ConstantInt *ShiftedAndCst =
1306 cast<ConstantInt>(ConstantExpr::getShl(AndCst, ShAmt));
1307 ConstantInt *ShiftedRHSCst =
1308 cast<ConstantInt>(ConstantExpr::getShl(RHS, ShAmt));
1309
1310 if (!ShiftedAndCst->isNegative() && !ShiftedRHSCst->isNegative())
1311 CanFold = true;
1312 }
Chris Lattner2188e402010-01-04 07:37:31 +00001313 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001314
Chris Lattner2188e402010-01-04 07:37:31 +00001315 if (CanFold) {
1316 Constant *NewCst;
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001317 if (ShiftOpcode == Instruction::Shl)
Chris Lattner2188e402010-01-04 07:37:31 +00001318 NewCst = ConstantExpr::getLShr(RHS, ShAmt);
1319 else
1320 NewCst = ConstantExpr::getShl(RHS, ShAmt);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001321
Chris Lattner2188e402010-01-04 07:37:31 +00001322 // Check to see if we are shifting out any of the bits being
1323 // compared.
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001324 if (ConstantExpr::get(ShiftOpcode, NewCst, ShAmt) != RHS) {
Chris Lattner2188e402010-01-04 07:37:31 +00001325 // If we shifted bits out, the fold is not going to work out.
1326 // As a special case, check to see if this means that the
1327 // result is always true or false now.
1328 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
Jakub Staszakbddea112013-06-06 20:18:46 +00001329 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00001330 if (ICI.getPredicate() == ICmpInst::ICMP_NE)
Jakub Staszakbddea112013-06-06 20:18:46 +00001331 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00001332 } else {
1333 ICI.setOperand(1, NewCst);
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001334 Constant *NewAndCst;
Kay Tiong Khood7b00ca2013-12-02 22:23:32 +00001335 if (ShiftOpcode == Instruction::Shl)
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001336 NewAndCst = ConstantExpr::getLShr(AndCst, ShAmt);
Chris Lattner2188e402010-01-04 07:37:31 +00001337 else
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001338 NewAndCst = ConstantExpr::getShl(AndCst, ShAmt);
1339 LHSI->setOperand(1, NewAndCst);
Chris Lattner2188e402010-01-04 07:37:31 +00001340 LHSI->setOperand(0, Shift->getOperand(0));
1341 Worklist.Add(Shift); // Shift is dead.
1342 return &ICI;
1343 }
1344 }
1345 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001346
Chris Lattner2188e402010-01-04 07:37:31 +00001347 // Turn ((X >> Y) & C) == 0 into (X & (C << Y)) == 0. The later is
1348 // preferable because it allows the C<<Y expression to be hoisted out
1349 // of a loop if Y is invariant and X is not.
1350 if (Shift && Shift->hasOneUse() && RHSV == 0 &&
1351 ICI.isEquality() && !Shift->isArithmeticShift() &&
1352 !isa<Constant>(Shift->getOperand(0))) {
1353 // Compute C << Y.
1354 Value *NS;
1355 if (Shift->getOpcode() == Instruction::LShr) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001356 NS = Builder->CreateShl(AndCst, Shift->getOperand(1));
Chris Lattner2188e402010-01-04 07:37:31 +00001357 } else {
1358 // Insert a logical shift.
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001359 NS = Builder->CreateLShr(AndCst, Shift->getOperand(1));
Chris Lattner2188e402010-01-04 07:37:31 +00001360 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001361
Chris Lattner2188e402010-01-04 07:37:31 +00001362 // Compute X & (C << Y).
Jim Grosbach129c52a2011-09-30 18:09:53 +00001363 Value *NewAnd =
Chris Lattner2188e402010-01-04 07:37:31 +00001364 Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName());
Jim Grosbach129c52a2011-09-30 18:09:53 +00001365
Chris Lattner2188e402010-01-04 07:37:31 +00001366 ICI.setOperand(0, NewAnd);
1367 return &ICI;
1368 }
Paul Redmond5917f4c2012-12-19 19:47:13 +00001369
David Majnemer0ffccf72014-08-24 09:10:57 +00001370 // (icmp pred (and (or (lshr X, Y), X), 1), 0) -->
1371 // (icmp pred (and X, (or (shl 1, Y), 1), 0))
1372 //
1373 // iff pred isn't signed
1374 {
1375 Value *X, *Y, *LShr;
1376 if (!ICI.isSigned() && RHSV == 0) {
1377 if (match(LHSI->getOperand(1), m_One())) {
1378 Constant *One = cast<Constant>(LHSI->getOperand(1));
1379 Value *Or = LHSI->getOperand(0);
1380 if (match(Or, m_Or(m_Value(LShr), m_Value(X))) &&
1381 match(LShr, m_LShr(m_Specific(X), m_Value(Y)))) {
1382 unsigned UsesRemoved = 0;
1383 if (LHSI->hasOneUse())
1384 ++UsesRemoved;
1385 if (Or->hasOneUse())
1386 ++UsesRemoved;
1387 if (LShr->hasOneUse())
1388 ++UsesRemoved;
1389 Value *NewOr = nullptr;
1390 // Compute X & ((1 << Y) | 1)
1391 if (auto *C = dyn_cast<Constant>(Y)) {
1392 if (UsesRemoved >= 1)
1393 NewOr =
1394 ConstantExpr::getOr(ConstantExpr::getNUWShl(One, C), One);
1395 } else {
1396 if (UsesRemoved >= 3)
1397 NewOr = Builder->CreateOr(Builder->CreateShl(One, Y,
1398 LShr->getName(),
1399 /*HasNUW=*/true),
1400 One, Or->getName());
1401 }
1402 if (NewOr) {
1403 Value *NewAnd = Builder->CreateAnd(X, NewOr, LHSI->getName());
1404 ICI.setOperand(0, NewAnd);
1405 return &ICI;
1406 }
1407 }
1408 }
1409 }
1410 }
1411
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001412 // Replace ((X & AndCst) > RHSV) with ((X & AndCst) != 0), if any
1413 // bit set in (X & AndCst) will produce a result greater than RHSV.
Paul Redmond5917f4c2012-12-19 19:47:13 +00001414 if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
Kay Tiong Khoo564560f2013-12-02 22:11:56 +00001415 unsigned NTZ = AndCst->getValue().countTrailingZeros();
1416 if ((NTZ < AndCst->getBitWidth()) &&
1417 APInt::getOneBitSet(AndCst->getBitWidth(), NTZ).ugt(RHSV))
Paul Redmond5917f4c2012-12-19 19:47:13 +00001418 return new ICmpInst(ICmpInst::ICMP_NE, LHSI,
1419 Constant::getNullValue(RHS->getType()));
1420 }
Chris Lattner2188e402010-01-04 07:37:31 +00001421 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001422
Chris Lattner2188e402010-01-04 07:37:31 +00001423 // Try to optimize things like "A[i]&42 == 0" to index computations.
1424 if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) {
1425 if (GetElementPtrInst *GEP =
1426 dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1427 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1428 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1429 !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) {
1430 ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1));
1431 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV,ICI, C))
1432 return Res;
1433 }
1434 }
David Majnemer414d4e52013-07-09 08:09:32 +00001435
1436 // X & -C == -C -> X > u ~C
1437 // X & -C != -C -> X <= u ~C
1438 // iff C is a power of 2
1439 if (ICI.isEquality() && RHS == LHSI->getOperand(1) && (-RHSV).isPowerOf2())
1440 return new ICmpInst(
1441 ICI.getPredicate() == ICmpInst::ICMP_EQ ? ICmpInst::ICMP_UGT
1442 : ICmpInst::ICMP_ULE,
1443 LHSI->getOperand(0), SubOne(RHS));
Chris Lattner2188e402010-01-04 07:37:31 +00001444 break;
1445
1446 case Instruction::Or: {
1447 if (!ICI.isEquality() || !RHS->isNullValue() || !LHSI->hasOneUse())
1448 break;
1449 Value *P, *Q;
1450 if (match(LHSI, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1451 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1452 // -> and (icmp eq P, null), (icmp eq Q, null).
Chris Lattner2188e402010-01-04 07:37:31 +00001453 Value *ICIP = Builder->CreateICmp(ICI.getPredicate(), P,
1454 Constant::getNullValue(P->getType()));
1455 Value *ICIQ = Builder->CreateICmp(ICI.getPredicate(), Q,
1456 Constant::getNullValue(Q->getType()));
1457 Instruction *Op;
1458 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1459 Op = BinaryOperator::CreateAnd(ICIP, ICIQ);
1460 else
1461 Op = BinaryOperator::CreateOr(ICIP, ICIQ);
1462 return Op;
1463 }
1464 break;
1465 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001466
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001467 case Instruction::Mul: { // (icmp pred (mul X, Val), CI)
1468 ConstantInt *Val = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1469 if (!Val) break;
1470
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +00001471 // If this is a signed comparison to 0 and the mul is sign preserving,
1472 // use the mul LHS operand instead.
1473 ICmpInst::Predicate pred = ICI.getPredicate();
1474 if (isSignTest(pred, RHS) && !Val->isZero() &&
1475 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1476 return new ICmpInst(Val->isNegative() ?
1477 ICmpInst::getSwappedPredicate(pred) : pred,
1478 LHSI->getOperand(0),
1479 Constant::getNullValue(RHS->getType()));
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001480
1481 break;
1482 }
1483
Chris Lattner2188e402010-01-04 07:37:31 +00001484 case Instruction::Shl: { // (icmp pred (shl X, ShAmt), CI)
Chris Lattner2188e402010-01-04 07:37:31 +00001485 uint32_t TypeBits = RHSV.getBitWidth();
David Majnemerb889e402013-06-28 23:42:03 +00001486 ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1487 if (!ShAmt) {
1488 Value *X;
1489 // (1 << X) pred P2 -> X pred Log2(P2)
1490 if (match(LHSI, m_Shl(m_One(), m_Value(X)))) {
1491 bool RHSVIsPowerOf2 = RHSV.isPowerOf2();
1492 ICmpInst::Predicate Pred = ICI.getPredicate();
1493 if (ICI.isUnsigned()) {
1494 if (!RHSVIsPowerOf2) {
1495 // (1 << X) < 30 -> X <= 4
1496 // (1 << X) <= 30 -> X <= 4
1497 // (1 << X) >= 30 -> X > 4
1498 // (1 << X) > 30 -> X > 4
1499 if (Pred == ICmpInst::ICMP_ULT)
1500 Pred = ICmpInst::ICMP_ULE;
1501 else if (Pred == ICmpInst::ICMP_UGE)
1502 Pred = ICmpInst::ICMP_UGT;
1503 }
1504 unsigned RHSLog2 = RHSV.logBase2();
1505
1506 // (1 << X) >= 2147483648 -> X >= 31 -> X == 31
David Majnemerb889e402013-06-28 23:42:03 +00001507 // (1 << X) < 2147483648 -> X < 31 -> X != 31
1508 if (RHSLog2 == TypeBits-1) {
1509 if (Pred == ICmpInst::ICMP_UGE)
1510 Pred = ICmpInst::ICMP_EQ;
David Majnemerb889e402013-06-28 23:42:03 +00001511 else if (Pred == ICmpInst::ICMP_ULT)
1512 Pred = ICmpInst::ICMP_NE;
1513 }
1514
1515 return new ICmpInst(Pred, X,
1516 ConstantInt::get(RHS->getType(), RHSLog2));
1517 } else if (ICI.isSigned()) {
1518 if (RHSV.isAllOnesValue()) {
1519 // (1 << X) <= -1 -> X == 31
1520 if (Pred == ICmpInst::ICMP_SLE)
1521 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1522 ConstantInt::get(RHS->getType(), TypeBits-1));
1523
1524 // (1 << X) > -1 -> X != 31
1525 if (Pred == ICmpInst::ICMP_SGT)
1526 return new ICmpInst(ICmpInst::ICMP_NE, X,
1527 ConstantInt::get(RHS->getType(), TypeBits-1));
1528 } else if (!RHSV) {
1529 // (1 << X) < 0 -> X == 31
1530 // (1 << X) <= 0 -> X == 31
1531 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1532 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1533 ConstantInt::get(RHS->getType(), TypeBits-1));
1534
1535 // (1 << X) >= 0 -> X != 31
1536 // (1 << X) > 0 -> X != 31
1537 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
1538 return new ICmpInst(ICmpInst::ICMP_NE, X,
1539 ConstantInt::get(RHS->getType(), TypeBits-1));
1540 }
1541 } else if (ICI.isEquality()) {
1542 if (RHSVIsPowerOf2)
1543 return new ICmpInst(
1544 Pred, X, ConstantInt::get(RHS->getType(), RHSV.logBase2()));
David Majnemerb889e402013-06-28 23:42:03 +00001545 }
1546 }
1547 break;
1548 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001549
Chris Lattner2188e402010-01-04 07:37:31 +00001550 // Check that the shift amount is in range. If not, don't perform
1551 // undefined shifts. When the shift is visited it will be
1552 // simplified.
1553 if (ShAmt->uge(TypeBits))
1554 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001555
Chris Lattner2188e402010-01-04 07:37:31 +00001556 if (ICI.isEquality()) {
1557 // If we are comparing against bits always shifted out, the
1558 // comparison cannot succeed.
1559 Constant *Comp =
1560 ConstantExpr::getShl(ConstantExpr::getLShr(RHS, ShAmt),
1561 ShAmt);
1562 if (Comp != RHS) {// Comparing against a bit that we know is zero.
1563 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jakub Staszakbddea112013-06-06 20:18:46 +00001564 Constant *Cst = Builder->getInt1(IsICMP_NE);
Chris Lattner2188e402010-01-04 07:37:31 +00001565 return ReplaceInstUsesWith(ICI, Cst);
1566 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001567
Chris Lattner98457102011-02-10 05:23:05 +00001568 // If the shift is NUW, then it is just shifting out zeros, no need for an
1569 // AND.
1570 if (cast<BinaryOperator>(LHSI)->hasNoUnsignedWrap())
1571 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1572 ConstantExpr::getLShr(RHS, ShAmt));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001573
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001574 // If the shift is NSW and we compare to 0, then it is just shifting out
1575 // sign bits, no need for an AND either.
1576 if (cast<BinaryOperator>(LHSI)->hasNoSignedWrap() && RHSV == 0)
1577 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1578 ConstantExpr::getLShr(RHS, ShAmt));
1579
Chris Lattner2188e402010-01-04 07:37:31 +00001580 if (LHSI->hasOneUse()) {
1581 // Otherwise strength reduce the shift into an and.
1582 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
Jakub Staszakbddea112013-06-06 20:18:46 +00001583 Constant *Mask = Builder->getInt(APInt::getLowBitsSet(TypeBits,
1584 TypeBits - ShAmtVal));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001585
Chris Lattner2188e402010-01-04 07:37:31 +00001586 Value *And =
1587 Builder->CreateAnd(LHSI->getOperand(0),Mask, LHSI->getName()+".mask");
1588 return new ICmpInst(ICI.getPredicate(), And,
Chris Lattner98457102011-02-10 05:23:05 +00001589 ConstantExpr::getLShr(RHS, ShAmt));
Chris Lattner2188e402010-01-04 07:37:31 +00001590 }
1591 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001592
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001593 // If this is a signed comparison to 0 and the shift is sign preserving,
1594 // use the shift LHS operand instead.
1595 ICmpInst::Predicate pred = ICI.getPredicate();
1596 if (isSignTest(pred, RHS) &&
1597 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1598 return new ICmpInst(pred,
1599 LHSI->getOperand(0),
1600 Constant::getNullValue(RHS->getType()));
1601
Chris Lattner2188e402010-01-04 07:37:31 +00001602 // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
1603 bool TrueIfSigned = false;
1604 if (LHSI->hasOneUse() &&
1605 isSignBitCheck(ICI.getPredicate(), RHS, TrueIfSigned)) {
1606 // (X << 31) <s 0 --> (X&1) != 0
Chris Lattner43273af2011-02-13 08:07:21 +00001607 Constant *Mask = ConstantInt::get(LHSI->getOperand(0)->getType(),
Jim Grosbach129c52a2011-09-30 18:09:53 +00001608 APInt::getOneBitSet(TypeBits,
Chris Lattner43273af2011-02-13 08:07:21 +00001609 TypeBits-ShAmt->getZExtValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00001610 Value *And =
1611 Builder->CreateAnd(LHSI->getOperand(0), Mask, LHSI->getName()+".mask");
1612 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
1613 And, Constant::getNullValue(And->getType()));
1614 }
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00001615
1616 // Transform (icmp pred iM (shl iM %v, N), CI)
Arnaud A. de Grandmaison71533052013-03-13 14:40:37 +00001617 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (CI>>N))
1618 // 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 +00001619 // This enables to get rid of the shift in favor of a trunc which can be
1620 // free on the target. It has the additional benefit of comparing to a
1621 // smaller constant, which will be target friendly.
1622 unsigned Amt = ShAmt->getLimitedValue(TypeBits-1);
Arnaud A. de Grandmaison71533052013-03-13 14:40:37 +00001623 if (LHSI->hasOneUse() &&
1624 Amt != 0 && RHSV.countTrailingZeros() >= Amt) {
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00001625 Type *NTy = IntegerType::get(ICI.getContext(), TypeBits - Amt);
1626 Constant *NCI = ConstantExpr::getTrunc(
1627 ConstantExpr::getAShr(RHS,
1628 ConstantInt::get(RHS->getType(), Amt)),
1629 NTy);
1630 return new ICmpInst(ICI.getPredicate(),
1631 Builder->CreateTrunc(LHSI->getOperand(0), NTy),
Arnaud A. de Grandmaison1fd843e2013-02-15 15:18:17 +00001632 NCI);
Arnaud A. de Grandmaison61c167c2013-02-15 14:35:47 +00001633 }
1634
Chris Lattner2188e402010-01-04 07:37:31 +00001635 break;
1636 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001637
Chris Lattner2188e402010-01-04 07:37:31 +00001638 case Instruction::LShr: // (icmp pred (shr X, ShAmt), CI)
Nick Lewycky174a7052011-02-28 08:31:40 +00001639 case Instruction::AShr: {
1640 // Handle equality comparisons of shift-by-constant.
1641 BinaryOperator *BO = cast<BinaryOperator>(LHSI);
1642 if (ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1643 if (Instruction *Res = FoldICmpShrCst(ICI, BO, ShAmt))
Chris Lattnerd369f572011-02-13 07:43:07 +00001644 return Res;
Nick Lewycky174a7052011-02-28 08:31:40 +00001645 }
1646
1647 // Handle exact shr's.
1648 if (ICI.isEquality() && BO->isExact() && BO->hasOneUse()) {
1649 if (RHSV.isMinValue())
1650 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), RHS);
1651 }
Chris Lattner2188e402010-01-04 07:37:31 +00001652 break;
Nick Lewycky174a7052011-02-28 08:31:40 +00001653 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001654
Chris Lattner2188e402010-01-04 07:37:31 +00001655 case Instruction::SDiv:
1656 case Instruction::UDiv:
1657 // Fold: icmp pred ([us]div X, C1), C2 -> range test
Jim Grosbach129c52a2011-09-30 18:09:53 +00001658 // Fold this div into the comparison, producing a range check.
1659 // Determine, based on the divide type, what the range is being
1660 // checked. If there is an overflow on the low or high side, remember
Chris Lattner2188e402010-01-04 07:37:31 +00001661 // it, otherwise compute the range [low, hi) bounding the new value.
1662 // See: InsertRangeTest above for the kinds of replacements possible.
1663 if (ConstantInt *DivRHS = dyn_cast<ConstantInt>(LHSI->getOperand(1)))
1664 if (Instruction *R = FoldICmpDivCst(ICI, cast<BinaryOperator>(LHSI),
1665 DivRHS))
1666 return R;
1667 break;
1668
David Majnemerf2a9a512013-07-09 07:50:59 +00001669 case Instruction::Sub: {
1670 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(0));
1671 if (!LHSC) break;
1672 const APInt &LHSV = LHSC->getValue();
1673
1674 // C1-X <u C2 -> (X|(C2-1)) == C1
1675 // iff C1 & (C2-1) == C2-1
1676 // C2 is a power of 2
1677 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
1678 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == (RHSV - 1))
1679 return new ICmpInst(ICmpInst::ICMP_EQ,
1680 Builder->CreateOr(LHSI->getOperand(1), RHSV - 1),
1681 LHSC);
1682
David Majnemereeed73b2013-07-09 09:24:35 +00001683 // C1-X >u C2 -> (X|C2) != C1
David Majnemerf2a9a512013-07-09 07:50:59 +00001684 // iff C1 & C2 == C2
1685 // C2+1 is a power of 2
1686 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1687 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == RHSV)
1688 return new ICmpInst(ICmpInst::ICMP_NE,
1689 Builder->CreateOr(LHSI->getOperand(1), RHSV), LHSC);
1690 break;
1691 }
1692
Chris Lattner2188e402010-01-04 07:37:31 +00001693 case Instruction::Add:
1694 // Fold: icmp pred (add X, C1), C2
1695 if (!ICI.isEquality()) {
1696 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1697 if (!LHSC) break;
1698 const APInt &LHSV = LHSC->getValue();
1699
1700 ConstantRange CR = ICI.makeConstantRange(ICI.getPredicate(), RHSV)
1701 .subtract(LHSV);
1702
1703 if (ICI.isSigned()) {
1704 if (CR.getLower().isSignBit()) {
1705 return new ICmpInst(ICmpInst::ICMP_SLT, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001706 Builder->getInt(CR.getUpper()));
Chris Lattner2188e402010-01-04 07:37:31 +00001707 } else if (CR.getUpper().isSignBit()) {
1708 return new ICmpInst(ICmpInst::ICMP_SGE, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001709 Builder->getInt(CR.getLower()));
Chris Lattner2188e402010-01-04 07:37:31 +00001710 }
1711 } else {
1712 if (CR.getLower().isMinValue()) {
1713 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001714 Builder->getInt(CR.getUpper()));
Chris Lattner2188e402010-01-04 07:37:31 +00001715 } else if (CR.getUpper().isMinValue()) {
1716 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0),
Jakub Staszakbddea112013-06-06 20:18:46 +00001717 Builder->getInt(CR.getLower()));
Chris Lattner2188e402010-01-04 07:37:31 +00001718 }
1719 }
David Majnemerfa90a0b2013-07-08 11:53:08 +00001720
David Majnemerbafa5372013-07-09 07:58:32 +00001721 // X-C1 <u C2 -> (X & -C2) == C1
1722 // iff C1 & (C2-1) == 0
1723 // C2 is a power of 2
David Majnemerfa90a0b2013-07-08 11:53:08 +00001724 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
David Majnemerbafa5372013-07-09 07:58:32 +00001725 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == 0)
David Majnemerfa90a0b2013-07-08 11:53:08 +00001726 return new ICmpInst(ICmpInst::ICMP_EQ,
1727 Builder->CreateAnd(LHSI->getOperand(0), -RHSV),
1728 ConstantExpr::getNeg(LHSC));
David Majnemerbafa5372013-07-09 07:58:32 +00001729
David Majnemereeed73b2013-07-09 09:24:35 +00001730 // X-C1 >u C2 -> (X & ~C2) != C1
David Majnemerbafa5372013-07-09 07:58:32 +00001731 // iff C1 & C2 == 0
1732 // C2+1 is a power of 2
1733 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1734 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == 0)
1735 return new ICmpInst(ICmpInst::ICMP_NE,
1736 Builder->CreateAnd(LHSI->getOperand(0), ~RHSV),
1737 ConstantExpr::getNeg(LHSC));
Chris Lattner2188e402010-01-04 07:37:31 +00001738 }
1739 break;
1740 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001741
Chris Lattner2188e402010-01-04 07:37:31 +00001742 // Simplify icmp_eq and icmp_ne instructions with integer constant RHS.
1743 if (ICI.isEquality()) {
1744 bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001745
1746 // If the first operand is (add|sub|and|or|xor|rem) with a constant, and
Chris Lattner2188e402010-01-04 07:37:31 +00001747 // the second operand is a constant, simplify a bit.
1748 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(LHSI)) {
1749 switch (BO->getOpcode()) {
1750 case Instruction::SRem:
1751 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
1752 if (RHSV == 0 && isa<ConstantInt>(BO->getOperand(1)) &&BO->hasOneUse()){
1753 const APInt &V = cast<ConstantInt>(BO->getOperand(1))->getValue();
Dan Gohman4ce1fb12010-04-08 23:03:40 +00001754 if (V.sgt(1) && V.isPowerOf2()) {
Chris Lattner2188e402010-01-04 07:37:31 +00001755 Value *NewRem =
1756 Builder->CreateURem(BO->getOperand(0), BO->getOperand(1),
1757 BO->getName());
1758 return new ICmpInst(ICI.getPredicate(), NewRem,
1759 Constant::getNullValue(BO->getType()));
1760 }
1761 }
1762 break;
1763 case Instruction::Add:
1764 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
1765 if (ConstantInt *BOp1C = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1766 if (BO->hasOneUse())
1767 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1768 ConstantExpr::getSub(RHS, BOp1C));
1769 } else if (RHSV == 0) {
1770 // Replace ((add A, B) != 0) with (A != -B) if A or B is
1771 // efficiently invertible, or if the add has just this one use.
1772 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001773
Chris Lattner2188e402010-01-04 07:37:31 +00001774 if (Value *NegVal = dyn_castNegVal(BOp1))
1775 return new ICmpInst(ICI.getPredicate(), BOp0, NegVal);
Chris Lattner31b106d2011-04-26 20:02:45 +00001776 if (Value *NegVal = dyn_castNegVal(BOp0))
Chris Lattner2188e402010-01-04 07:37:31 +00001777 return new ICmpInst(ICI.getPredicate(), NegVal, BOp1);
Chris Lattner31b106d2011-04-26 20:02:45 +00001778 if (BO->hasOneUse()) {
Chris Lattner2188e402010-01-04 07:37:31 +00001779 Value *Neg = Builder->CreateNeg(BOp1);
1780 Neg->takeName(BO);
1781 return new ICmpInst(ICI.getPredicate(), BOp0, Neg);
1782 }
1783 }
1784 break;
1785 case Instruction::Xor:
1786 // For the xor case, we can xor two constants together, eliminating
1787 // the explicit xor.
Benjamin Kramerc9708492011-06-13 15:24:24 +00001788 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
1789 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
Chris Lattner2188e402010-01-04 07:37:31 +00001790 ConstantExpr::getXor(RHS, BOC));
Benjamin Kramerc9708492011-06-13 15:24:24 +00001791 } else if (RHSV == 0) {
1792 // Replace ((xor A, B) != 0) with (A != B)
Chris Lattner2188e402010-01-04 07:37:31 +00001793 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1794 BO->getOperand(1));
Benjamin Kramerc9708492011-06-13 15:24:24 +00001795 }
Chris Lattner2188e402010-01-04 07:37:31 +00001796 break;
Benjamin Kramerc9708492011-06-13 15:24:24 +00001797 case Instruction::Sub:
1798 // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants.
1799 if (ConstantInt *BOp0C = dyn_cast<ConstantInt>(BO->getOperand(0))) {
1800 if (BO->hasOneUse())
1801 return new ICmpInst(ICI.getPredicate(), BO->getOperand(1),
1802 ConstantExpr::getSub(BOp0C, RHS));
1803 } else if (RHSV == 0) {
1804 // Replace ((sub A, B) != 0) with (A != B)
1805 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1806 BO->getOperand(1));
1807 }
1808 break;
Chris Lattner2188e402010-01-04 07:37:31 +00001809 case Instruction::Or:
1810 // If bits are being or'd in that are not present in the constant we
1811 // are comparing against, then the comparison could never succeed!
Eli Friedman0428a612010-07-29 18:03:33 +00001812 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00001813 Constant *NotCI = ConstantExpr::getNot(RHS);
1814 if (!ConstantExpr::getAnd(BOC, NotCI)->isNullValue())
Jakub Staszakbddea112013-06-06 20:18:46 +00001815 return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
Chris Lattner2188e402010-01-04 07:37:31 +00001816 }
1817 break;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001818
Chris Lattner2188e402010-01-04 07:37:31 +00001819 case Instruction::And:
1820 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1821 // If bits are being compared against that are and'd out, then the
1822 // comparison can never succeed!
1823 if ((RHSV & ~BOC->getValue()) != 0)
Jakub Staszakbddea112013-06-06 20:18:46 +00001824 return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
Jim Grosbach129c52a2011-09-30 18:09:53 +00001825
Chris Lattner2188e402010-01-04 07:37:31 +00001826 // If we have ((X & C) == C), turn it into ((X & C) != 0).
1827 if (RHS == BOC && RHSV.isPowerOf2())
1828 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ :
1829 ICmpInst::ICMP_NE, LHSI,
1830 Constant::getNullValue(RHS->getType()));
Benjamin Kramer9eca5fe2011-07-04 20:16:36 +00001831
1832 // Don't perform the following transforms if the AND has multiple uses
1833 if (!BO->hasOneUse())
1834 break;
1835
Chris Lattner2188e402010-01-04 07:37:31 +00001836 // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
1837 if (BOC->getValue().isSignBit()) {
1838 Value *X = BO->getOperand(0);
1839 Constant *Zero = Constant::getNullValue(X->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00001840 ICmpInst::Predicate pred = isICMP_NE ?
Chris Lattner2188e402010-01-04 07:37:31 +00001841 ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
1842 return new ICmpInst(pred, X, Zero);
1843 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001844
Chris Lattner2188e402010-01-04 07:37:31 +00001845 // ((X & ~7) == 0) --> X < 8
1846 if (RHSV == 0 && isHighOnes(BOC)) {
1847 Value *X = BO->getOperand(0);
1848 Constant *NegX = ConstantExpr::getNeg(BOC);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001849 ICmpInst::Predicate pred = isICMP_NE ?
Chris Lattner2188e402010-01-04 07:37:31 +00001850 ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
1851 return new ICmpInst(pred, X, NegX);
1852 }
1853 }
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001854 break;
1855 case Instruction::Mul:
Arnaud A. de Grandmaison3ee88e82013-03-25 11:47:38 +00001856 if (RHSV == 0 && BO->hasNoSignedWrap()) {
Arnaud A. de Grandmaison9c383d62013-03-25 09:48:49 +00001857 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1858 // The trivial case (mul X, 0) is handled by InstSimplify
1859 // General case : (mul X, C) != 0 iff X != 0
1860 // (mul X, C) == 0 iff X == 0
1861 if (!BOC->isZero())
1862 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1863 Constant::getNullValue(RHS->getType()));
1864 }
1865 }
1866 break;
Chris Lattner2188e402010-01-04 07:37:31 +00001867 default: break;
1868 }
1869 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(LHSI)) {
1870 // Handle icmp {eq|ne} <intrinsic>, intcst.
Chris Lattner54f4e392010-01-05 18:09:56 +00001871 switch (II->getIntrinsicID()) {
1872 case Intrinsic::bswap:
Chris Lattner2188e402010-01-04 07:37:31 +00001873 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00001874 ICI.setOperand(0, II->getArgOperand(0));
Jakub Staszakbddea112013-06-06 20:18:46 +00001875 ICI.setOperand(1, Builder->getInt(RHSV.byteSwap()));
Chris Lattner2188e402010-01-04 07:37:31 +00001876 return &ICI;
Chris Lattner54f4e392010-01-05 18:09:56 +00001877 case Intrinsic::ctlz:
1878 case Intrinsic::cttz:
1879 // ctz(A) == bitwidth(a) -> A == 0 and likewise for !=
1880 if (RHSV == RHS->getType()->getBitWidth()) {
1881 Worklist.Add(II);
Gabor Greif7ccec092010-06-24 16:11:44 +00001882 ICI.setOperand(0, II->getArgOperand(0));
Chris Lattner54f4e392010-01-05 18:09:56 +00001883 ICI.setOperand(1, ConstantInt::get(RHS->getType(), 0));
1884 return &ICI;
1885 }
1886 break;
1887 case Intrinsic::ctpop:
1888 // popcount(A) == 0 -> A == 0 and likewise for !=
1889 if (RHS->isZero()) {
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, RHS);
1893 return &ICI;
1894 }
1895 break;
1896 default:
Duncan Sands41b4a6b2010-07-12 08:16:59 +00001897 break;
Chris Lattner2188e402010-01-04 07:37:31 +00001898 }
1899 }
1900 }
Craig Topperf40110f2014-04-25 05:29:35 +00001901 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001902}
1903
1904/// visitICmpInstWithCastAndCast - Handle icmp (cast x to y), (cast/cst).
1905/// We only handle extending casts so far.
1906///
1907Instruction *InstCombiner::visitICmpInstWithCastAndCast(ICmpInst &ICI) {
1908 const CastInst *LHSCI = cast<CastInst>(ICI.getOperand(0));
1909 Value *LHSCIOp = LHSCI->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00001910 Type *SrcTy = LHSCIOp->getType();
1911 Type *DestTy = LHSCI->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00001912 Value *RHSCIOp;
1913
Jim Grosbach129c52a2011-09-30 18:09:53 +00001914 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
Chris Lattner2188e402010-01-04 07:37:31 +00001915 // integer type is the same size as the pointer type.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001916 if (DL && LHSCI->getOpcode() == Instruction::PtrToInt &&
1917 DL->getPointerTypeSizeInBits(SrcTy) == DestTy->getIntegerBitWidth()) {
Craig Topperf40110f2014-04-25 05:29:35 +00001918 Value *RHSOp = nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001919 if (Constant *RHSC = dyn_cast<Constant>(ICI.getOperand(1))) {
1920 RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
1921 } else if (PtrToIntInst *RHSC = dyn_cast<PtrToIntInst>(ICI.getOperand(1))) {
1922 RHSOp = RHSC->getOperand(0);
1923 // If the pointer types don't match, insert a bitcast.
1924 if (LHSCIOp->getType() != RHSOp->getType())
1925 RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType());
1926 }
1927
1928 if (RHSOp)
1929 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSOp);
1930 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00001931
Chris Lattner2188e402010-01-04 07:37:31 +00001932 // The code below only handles extension cast instructions, so far.
1933 // Enforce this.
1934 if (LHSCI->getOpcode() != Instruction::ZExt &&
1935 LHSCI->getOpcode() != Instruction::SExt)
Craig Topperf40110f2014-04-25 05:29:35 +00001936 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001937
1938 bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
1939 bool isSignedCmp = ICI.isSigned();
1940
1941 if (CastInst *CI = dyn_cast<CastInst>(ICI.getOperand(1))) {
1942 // Not an extension from the same type?
1943 RHSCIOp = CI->getOperand(0);
Jim Grosbach129c52a2011-09-30 18:09:53 +00001944 if (RHSCIOp->getType() != LHSCIOp->getType())
Craig Topperf40110f2014-04-25 05:29:35 +00001945 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00001946
Chris Lattner2188e402010-01-04 07:37:31 +00001947 // If the signedness of the two casts doesn't agree (i.e. one is a sext
1948 // and the other is a zext), then we can't handle this.
1949 if (CI->getOpcode() != LHSCI->getOpcode())
Craig Topperf40110f2014-04-25 05:29:35 +00001950 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001951
1952 // Deal with equality cases early.
1953 if (ICI.isEquality())
1954 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1955
1956 // A signed comparison of sign extended values simplifies into a
1957 // signed comparison.
1958 if (isSignedCmp && isSignedExt)
1959 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1960
1961 // The other three cases all fold into an unsigned comparison.
1962 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
1963 }
1964
1965 // If we aren't dealing with a constant on the RHS, exit early
1966 ConstantInt *CI = dyn_cast<ConstantInt>(ICI.getOperand(1));
1967 if (!CI)
Craig Topperf40110f2014-04-25 05:29:35 +00001968 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001969
1970 // Compute the constant that would happen if we truncated to SrcTy then
1971 // reextended to DestTy.
1972 Constant *Res1 = ConstantExpr::getTrunc(CI, SrcTy);
1973 Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(),
1974 Res1, DestTy);
1975
1976 // If the re-extended constant didn't change...
1977 if (Res2 == CI) {
1978 // Deal with equality cases early.
1979 if (ICI.isEquality())
1980 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1981
1982 // A signed comparison of sign extended values simplifies into a
1983 // signed comparison.
1984 if (isSignedExt && isSignedCmp)
1985 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1986
1987 // The other three cases all fold into an unsigned comparison.
1988 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, Res1);
1989 }
1990
Jim Grosbach129c52a2011-09-30 18:09:53 +00001991 // The re-extended constant changed so the constant cannot be represented
Chris Lattner2188e402010-01-04 07:37:31 +00001992 // in the shorter type. Consequently, we cannot emit a simple comparison.
Duncan Sands8fb2c382011-01-20 13:21:55 +00001993 // All the cases that fold to true or false will have already been handled
1994 // by SimplifyICmpInst, so only deal with the tricky case.
Chris Lattner2188e402010-01-04 07:37:31 +00001995
Duncan Sands8fb2c382011-01-20 13:21:55 +00001996 if (isSignedCmp || !isSignedExt)
Craig Topperf40110f2014-04-25 05:29:35 +00001997 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00001998
1999 // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
2000 // should have been folded away previously and not enter in here.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002001
2002 // We're performing an unsigned comp with a sign extended value.
2003 // This is true if the input is >= 0. [aka >s -1]
2004 Constant *NegOne = Constant::getAllOnesValue(SrcTy);
2005 Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICI.getName());
Chris Lattner2188e402010-01-04 07:37:31 +00002006
2007 // Finally, return the value computed.
Duncan Sands8fb2c382011-01-20 13:21:55 +00002008 if (ICI.getPredicate() == ICmpInst::ICMP_ULT)
Chris Lattner2188e402010-01-04 07:37:31 +00002009 return ReplaceInstUsesWith(ICI, Result);
2010
Duncan Sands8fb2c382011-01-20 13:21:55 +00002011 assert(ICI.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
Chris Lattner2188e402010-01-04 07:37:31 +00002012 return BinaryOperator::CreateNot(Result);
2013}
2014
Chris Lattneree61c1d2010-12-19 17:52:50 +00002015/// ProcessUGT_ADDCST_ADD - The caller has matched a pattern of the form:
2016/// I = icmp ugt (add (add A, B), CI2), CI1
Chris Lattnerc56c8452010-12-19 18:22:06 +00002017/// If this is of the form:
2018/// sum = a + b
2019/// if (sum+128 >u 255)
2020/// Then replace it with llvm.sadd.with.overflow.i8.
2021///
Chris Lattneree61c1d2010-12-19 17:52:50 +00002022static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
2023 ConstantInt *CI2, ConstantInt *CI1,
Chris Lattnerce2995a2010-12-19 18:38:44 +00002024 InstCombiner &IC) {
Chris Lattnerf29562d2010-12-19 17:59:02 +00002025 // The transformation we're trying to do here is to transform this into an
2026 // llvm.sadd.with.overflow. To do this, we have to replace the original add
2027 // with a narrower add, and discard the add-with-constant that is part of the
2028 // range check (if we can't eliminate it, this isn't profitable).
Jim Grosbach129c52a2011-09-30 18:09:53 +00002029
Chris Lattnerf29562d2010-12-19 17:59:02 +00002030 // In order to eliminate the add-with-constant, the compare can be its only
2031 // use.
Chris Lattnerc56c8452010-12-19 18:22:06 +00002032 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
Craig Topperf40110f2014-04-25 05:29:35 +00002033 if (!AddWithCst->hasOneUse()) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002034
Chris Lattnerc56c8452010-12-19 18:22:06 +00002035 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
Craig Topperf40110f2014-04-25 05:29:35 +00002036 if (!CI2->getValue().isPowerOf2()) return nullptr;
Chris Lattnerc56c8452010-12-19 18:22:06 +00002037 unsigned NewWidth = CI2->getValue().countTrailingZeros();
Craig Topperf40110f2014-04-25 05:29:35 +00002038 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002039
Chris Lattnerc56c8452010-12-19 18:22:06 +00002040 // The width of the new add formed is 1 more than the bias.
2041 ++NewWidth;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002042
Chris Lattnerc56c8452010-12-19 18:22:06 +00002043 // Check to see that CI1 is an all-ones value with NewWidth bits.
2044 if (CI1->getBitWidth() == NewWidth ||
2045 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
Craig Topperf40110f2014-04-25 05:29:35 +00002046 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002047
Eli Friedmanb3f9b062011-11-28 23:32:19 +00002048 // This is only really a signed overflow check if the inputs have been
2049 // sign-extended; check for that condition. For example, if CI2 is 2^31 and
2050 // the operands of the add are 64 bits wide, we need at least 33 sign bits.
2051 unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
Hal Finkel60db0582014-09-07 18:57:58 +00002052 if (IC.ComputeNumSignBits(A, 0, &I) < NeededSignBits ||
2053 IC.ComputeNumSignBits(B, 0, &I) < NeededSignBits)
Craig Topperf40110f2014-04-25 05:29:35 +00002054 return nullptr;
Eli Friedmanb3f9b062011-11-28 23:32:19 +00002055
Jim Grosbach129c52a2011-09-30 18:09:53 +00002056 // In order to replace the original add with a narrower
Chris Lattnerc56c8452010-12-19 18:22:06 +00002057 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
2058 // and truncates that discard the high bits of the add. Verify that this is
2059 // the case.
2060 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
Chandler Carruthcdf47882014-03-09 03:16:01 +00002061 for (User *U : OrigAdd->users()) {
2062 if (U == AddWithCst) continue;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002063
Chris Lattnerc56c8452010-12-19 18:22:06 +00002064 // Only accept truncates for now. We would really like a nice recursive
2065 // predicate like SimplifyDemandedBits, but which goes downwards the use-def
2066 // chain to see which bits of a value are actually demanded. If the
2067 // original add had another add which was then immediately truncated, we
2068 // could still do the transformation.
Chandler Carruthcdf47882014-03-09 03:16:01 +00002069 TruncInst *TI = dyn_cast<TruncInst>(U);
Craig Topperf40110f2014-04-25 05:29:35 +00002070 if (!TI || TI->getType()->getPrimitiveSizeInBits() > NewWidth)
2071 return nullptr;
Chris Lattnerc56c8452010-12-19 18:22:06 +00002072 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002073
Chris Lattneree61c1d2010-12-19 17:52:50 +00002074 // If the pattern matches, truncate the inputs to the narrower type and
2075 // use the sadd_with_overflow intrinsic to efficiently compute both the
2076 // result and the overflow bit.
Chris Lattner79874562010-12-19 18:35:09 +00002077 Module *M = I.getParent()->getParent()->getParent();
Jim Grosbach129c52a2011-09-30 18:09:53 +00002078
Jay Foadb804a2b2011-07-12 14:06:48 +00002079 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
Chris Lattner79874562010-12-19 18:35:09 +00002080 Value *F = Intrinsic::getDeclaration(M, Intrinsic::sadd_with_overflow,
Benjamin Kramere6e19332011-07-14 17:45:39 +00002081 NewType);
Chris Lattner79874562010-12-19 18:35:09 +00002082
Chris Lattnerce2995a2010-12-19 18:38:44 +00002083 InstCombiner::BuilderTy *Builder = IC.Builder;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002084
Chris Lattner79874562010-12-19 18:35:09 +00002085 // Put the new code above the original add, in case there are any uses of the
2086 // add between the add and the compare.
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002087 Builder->SetInsertPoint(OrigAdd);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002088
Chris Lattner79874562010-12-19 18:35:09 +00002089 Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc");
2090 Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc");
2091 CallInst *Call = Builder->CreateCall2(F, TruncA, TruncB, "sadd");
2092 Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result");
2093 Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00002094
Chris Lattneree61c1d2010-12-19 17:52:50 +00002095 // The inner add was the result of the narrow add, zero extended to the
2096 // wider type. Replace it with the result computed by the intrinsic.
Chris Lattnerce2995a2010-12-19 18:38:44 +00002097 IC.ReplaceInstUsesWith(*OrigAdd, ZExt);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002098
Chris Lattner79874562010-12-19 18:35:09 +00002099 // The original icmp gets replaced with the overflow value.
2100 return ExtractValueInst::Create(Call, 1, "sadd.overflow");
Chris Lattneree61c1d2010-12-19 17:52:50 +00002101}
Chris Lattner2188e402010-01-04 07:37:31 +00002102
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002103static Instruction *ProcessUAddIdiom(Instruction &I, Value *OrigAddV,
2104 InstCombiner &IC) {
2105 // Don't bother doing this transformation for pointers, don't do it for
2106 // vectors.
Craig Topperf40110f2014-04-25 05:29:35 +00002107 if (!isa<IntegerType>(OrigAddV->getType())) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002108
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002109 // If the add is a constant expr, then we don't bother transforming it.
2110 Instruction *OrigAdd = dyn_cast<Instruction>(OrigAddV);
Craig Topperf40110f2014-04-25 05:29:35 +00002111 if (!OrigAdd) return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002112
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002113 Value *LHS = OrigAdd->getOperand(0), *RHS = OrigAdd->getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002114
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002115 // Put the new code above the original add, in case there are any uses of the
2116 // add between the add and the compare.
2117 InstCombiner::BuilderTy *Builder = IC.Builder;
2118 Builder->SetInsertPoint(OrigAdd);
2119
2120 Module *M = I.getParent()->getParent()->getParent();
Jay Foadb804a2b2011-07-12 14:06:48 +00002121 Type *Ty = LHS->getType();
Benjamin Kramere6e19332011-07-14 17:45:39 +00002122 Value *F = Intrinsic::getDeclaration(M, Intrinsic::uadd_with_overflow, Ty);
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002123 CallInst *Call = Builder->CreateCall2(F, LHS, RHS, "uadd");
2124 Value *Add = Builder->CreateExtractValue(Call, 0);
2125
2126 IC.ReplaceInstUsesWith(*OrigAdd, Add);
2127
2128 // The original icmp gets replaced with the overflow value.
2129 return ExtractValueInst::Create(Call, 1, "uadd.overflow");
2130}
2131
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002132/// \brief Recognize and process idiom involving test for multiplication
2133/// overflow.
2134///
2135/// The caller has matched a pattern of the form:
2136/// I = cmp u (mul(zext A, zext B), V
2137/// The function checks if this is a test for overflow and if so replaces
2138/// multiplication with call to 'mul.with.overflow' intrinsic.
2139///
2140/// \param I Compare instruction.
2141/// \param MulVal Result of 'mult' instruction. It is one of the arguments of
2142/// the compare instruction. Must be of integer type.
2143/// \param OtherVal The other argument of compare instruction.
2144/// \returns Instruction which must replace the compare instruction, NULL if no
2145/// replacement required.
2146static Instruction *ProcessUMulZExtIdiom(ICmpInst &I, Value *MulVal,
2147 Value *OtherVal, InstCombiner &IC) {
Benjamin Kramerc96a7f82014-06-24 10:47:52 +00002148 // Don't bother doing this transformation for pointers, don't do it for
2149 // vectors.
2150 if (!isa<IntegerType>(MulVal->getType()))
2151 return nullptr;
2152
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002153 assert(I.getOperand(0) == MulVal || I.getOperand(1) == MulVal);
2154 assert(I.getOperand(0) == OtherVal || I.getOperand(1) == OtherVal);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002155 Instruction *MulInstr = cast<Instruction>(MulVal);
2156 assert(MulInstr->getOpcode() == Instruction::Mul);
2157
2158 Instruction *LHS = cast<Instruction>(MulInstr->getOperand(0)),
2159 *RHS = cast<Instruction>(MulInstr->getOperand(1));
2160 assert(LHS->getOpcode() == Instruction::ZExt);
2161 assert(RHS->getOpcode() == Instruction::ZExt);
2162 Value *A = LHS->getOperand(0), *B = RHS->getOperand(0);
2163
2164 // Calculate type and width of the result produced by mul.with.overflow.
2165 Type *TyA = A->getType(), *TyB = B->getType();
2166 unsigned WidthA = TyA->getPrimitiveSizeInBits(),
2167 WidthB = TyB->getPrimitiveSizeInBits();
2168 unsigned MulWidth;
2169 Type *MulType;
2170 if (WidthB > WidthA) {
2171 MulWidth = WidthB;
2172 MulType = TyB;
2173 } else {
2174 MulWidth = WidthA;
2175 MulType = TyA;
2176 }
2177
2178 // In order to replace the original mul with a narrower mul.with.overflow,
2179 // all uses must ignore upper bits of the product. The number of used low
2180 // bits must be not greater than the width of mul.with.overflow.
2181 if (MulVal->hasNUsesOrMore(2))
2182 for (User *U : MulVal->users()) {
2183 if (U == &I)
2184 continue;
2185 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2186 // Check if truncation ignores bits above MulWidth.
2187 unsigned TruncWidth = TI->getType()->getPrimitiveSizeInBits();
2188 if (TruncWidth > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00002189 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002190 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2191 // Check if AND ignores bits above MulWidth.
2192 if (BO->getOpcode() != Instruction::And)
Craig Topperf40110f2014-04-25 05:29:35 +00002193 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002194 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
2195 const APInt &CVal = CI->getValue();
2196 if (CVal.getBitWidth() - CVal.countLeadingZeros() > MulWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00002197 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002198 }
2199 } else {
2200 // Other uses prohibit this transformation.
Craig Topperf40110f2014-04-25 05:29:35 +00002201 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002202 }
2203 }
2204
2205 // Recognize patterns
2206 switch (I.getPredicate()) {
2207 case ICmpInst::ICMP_EQ:
2208 case ICmpInst::ICMP_NE:
2209 // Recognize pattern:
2210 // mulval = mul(zext A, zext B)
2211 // cmp eq/neq mulval, zext trunc mulval
2212 if (ZExtInst *Zext = dyn_cast<ZExtInst>(OtherVal))
2213 if (Zext->hasOneUse()) {
2214 Value *ZextArg = Zext->getOperand(0);
2215 if (TruncInst *Trunc = dyn_cast<TruncInst>(ZextArg))
2216 if (Trunc->getType()->getPrimitiveSizeInBits() == MulWidth)
2217 break; //Recognized
2218 }
2219
2220 // Recognize pattern:
2221 // mulval = mul(zext A, zext B)
2222 // cmp eq/neq mulval, and(mulval, mask), mask selects low MulWidth bits.
2223 ConstantInt *CI;
2224 Value *ValToMask;
2225 if (match(OtherVal, m_And(m_Value(ValToMask), m_ConstantInt(CI)))) {
2226 if (ValToMask != MulVal)
Craig Topperf40110f2014-04-25 05:29:35 +00002227 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002228 const APInt &CVal = CI->getValue() + 1;
2229 if (CVal.isPowerOf2()) {
2230 unsigned MaskWidth = CVal.logBase2();
2231 if (MaskWidth == MulWidth)
2232 break; // Recognized
2233 }
2234 }
Craig Topperf40110f2014-04-25 05:29:35 +00002235 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002236
2237 case ICmpInst::ICMP_UGT:
2238 // Recognize pattern:
2239 // mulval = mul(zext A, zext B)
2240 // cmp ugt mulval, max
2241 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2242 APInt MaxVal = APInt::getMaxValue(MulWidth);
2243 MaxVal = MaxVal.zext(CI->getBitWidth());
2244 if (MaxVal.eq(CI->getValue()))
2245 break; // Recognized
2246 }
Craig Topperf40110f2014-04-25 05:29:35 +00002247 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002248
2249 case ICmpInst::ICMP_UGE:
2250 // Recognize pattern:
2251 // mulval = mul(zext A, zext B)
2252 // cmp uge mulval, max+1
2253 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2254 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
2255 if (MaxVal.eq(CI->getValue()))
2256 break; // Recognized
2257 }
Craig Topperf40110f2014-04-25 05:29:35 +00002258 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002259
2260 case ICmpInst::ICMP_ULE:
2261 // Recognize pattern:
2262 // mulval = mul(zext A, zext B)
2263 // cmp ule mulval, max
2264 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
2265 APInt MaxVal = APInt::getMaxValue(MulWidth);
2266 MaxVal = MaxVal.zext(CI->getBitWidth());
2267 if (MaxVal.eq(CI->getValue()))
2268 break; // Recognized
2269 }
Craig Topperf40110f2014-04-25 05:29:35 +00002270 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002271
2272 case ICmpInst::ICMP_ULT:
2273 // Recognize pattern:
2274 // mulval = mul(zext A, zext B)
2275 // cmp ule mulval, max + 1
2276 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal)) {
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00002277 APInt MaxVal = APInt::getOneBitSet(CI->getBitWidth(), MulWidth);
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002278 if (MaxVal.eq(CI->getValue()))
2279 break; // Recognized
2280 }
Craig Topperf40110f2014-04-25 05:29:35 +00002281 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002282
2283 default:
Craig Topperf40110f2014-04-25 05:29:35 +00002284 return nullptr;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002285 }
2286
2287 InstCombiner::BuilderTy *Builder = IC.Builder;
2288 Builder->SetInsertPoint(MulInstr);
2289 Module *M = I.getParent()->getParent()->getParent();
2290
2291 // Replace: mul(zext A, zext B) --> mul.with.overflow(A, B)
2292 Value *MulA = A, *MulB = B;
2293 if (WidthA < MulWidth)
2294 MulA = Builder->CreateZExt(A, MulType);
2295 if (WidthB < MulWidth)
2296 MulB = Builder->CreateZExt(B, MulType);
2297 Value *F =
2298 Intrinsic::getDeclaration(M, Intrinsic::umul_with_overflow, MulType);
2299 CallInst *Call = Builder->CreateCall2(F, MulA, MulB, "umul");
2300 IC.Worklist.Add(MulInstr);
2301
2302 // If there are uses of mul result other than the comparison, we know that
2303 // they are truncation or binary AND. Change them to use result of
Serge Pavlovb5f3ddc2014-04-14 02:20:19 +00002304 // mul.with.overflow and adjust properly mask/size.
Serge Pavlov4bb54d52014-04-13 18:23:41 +00002305 if (MulVal->hasNUsesOrMore(2)) {
2306 Value *Mul = Builder->CreateExtractValue(Call, 0, "umul.value");
2307 for (User *U : MulVal->users()) {
2308 if (U == &I || U == OtherVal)
2309 continue;
2310 if (TruncInst *TI = dyn_cast<TruncInst>(U)) {
2311 if (TI->getType()->getPrimitiveSizeInBits() == MulWidth)
2312 IC.ReplaceInstUsesWith(*TI, Mul);
2313 else
2314 TI->setOperand(0, Mul);
2315 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U)) {
2316 assert(BO->getOpcode() == Instruction::And);
2317 // Replace (mul & mask) --> zext (mul.with.overflow & short_mask)
2318 ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
2319 APInt ShortMask = CI->getValue().trunc(MulWidth);
2320 Value *ShortAnd = Builder->CreateAnd(Mul, ShortMask);
2321 Instruction *Zext =
2322 cast<Instruction>(Builder->CreateZExt(ShortAnd, BO->getType()));
2323 IC.Worklist.Add(Zext);
2324 IC.ReplaceInstUsesWith(*BO, Zext);
2325 } else {
2326 llvm_unreachable("Unexpected Binary operation");
2327 }
2328 IC.Worklist.Add(cast<Instruction>(U));
2329 }
2330 }
2331 if (isa<Instruction>(OtherVal))
2332 IC.Worklist.Add(cast<Instruction>(OtherVal));
2333
2334 // The original icmp gets replaced with the overflow value, maybe inverted
2335 // depending on predicate.
2336 bool Inverse = false;
2337 switch (I.getPredicate()) {
2338 case ICmpInst::ICMP_NE:
2339 break;
2340 case ICmpInst::ICMP_EQ:
2341 Inverse = true;
2342 break;
2343 case ICmpInst::ICMP_UGT:
2344 case ICmpInst::ICMP_UGE:
2345 if (I.getOperand(0) == MulVal)
2346 break;
2347 Inverse = true;
2348 break;
2349 case ICmpInst::ICMP_ULT:
2350 case ICmpInst::ICMP_ULE:
2351 if (I.getOperand(1) == MulVal)
2352 break;
2353 Inverse = true;
2354 break;
2355 default:
2356 llvm_unreachable("Unexpected predicate");
2357 }
2358 if (Inverse) {
2359 Value *Res = Builder->CreateExtractValue(Call, 1);
2360 return BinaryOperator::CreateNot(Res);
2361 }
2362
2363 return ExtractValueInst::Create(Call, 1);
2364}
2365
Owen Andersond490c2d2011-01-11 00:36:45 +00002366// DemandedBitsLHSMask - When performing a comparison against a constant,
2367// it is possible that not all the bits in the LHS are demanded. This helper
2368// method computes the mask that IS demanded.
2369static APInt DemandedBitsLHSMask(ICmpInst &I,
2370 unsigned BitWidth, bool isSignCheck) {
2371 if (isSignCheck)
2372 return APInt::getSignBit(BitWidth);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002373
Owen Andersond490c2d2011-01-11 00:36:45 +00002374 ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1));
2375 if (!CI) return APInt::getAllOnesValue(BitWidth);
Owen Anderson0022a4b2011-01-11 18:26:37 +00002376 const APInt &RHS = CI->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00002377
Owen Andersond490c2d2011-01-11 00:36:45 +00002378 switch (I.getPredicate()) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00002379 // For a UGT comparison, we don't care about any bits that
Owen Andersond490c2d2011-01-11 00:36:45 +00002380 // correspond to the trailing ones of the comparand. The value of these
2381 // bits doesn't impact the outcome of the comparison, because any value
2382 // greater than the RHS must differ in a bit higher than these due to carry.
2383 case ICmpInst::ICMP_UGT: {
2384 unsigned trailingOnes = RHS.countTrailingOnes();
2385 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes);
2386 return ~lowBitsSet;
2387 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002388
Owen Andersond490c2d2011-01-11 00:36:45 +00002389 // Similarly, for a ULT comparison, we don't care about the trailing zeros.
2390 // Any value less than the RHS must differ in a higher bit because of carries.
2391 case ICmpInst::ICMP_ULT: {
2392 unsigned trailingZeros = RHS.countTrailingZeros();
2393 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros);
2394 return ~lowBitsSet;
2395 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002396
Owen Andersond490c2d2011-01-11 00:36:45 +00002397 default:
2398 return APInt::getAllOnesValue(BitWidth);
2399 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002400
Owen Andersond490c2d2011-01-11 00:36:45 +00002401}
Chris Lattner2188e402010-01-04 07:37:31 +00002402
Quentin Colombet5ab55552013-09-09 20:56:48 +00002403/// \brief Check if the order of \p Op0 and \p Op1 as operand in an ICmpInst
2404/// should be swapped.
Alp Tokercb402912014-01-24 17:20:08 +00002405/// The decision is based on how many times these two operands are reused
Quentin Colombet5ab55552013-09-09 20:56:48 +00002406/// as subtract operands and their positions in those instructions.
2407/// The rational is that several architectures use the same instruction for
2408/// both subtract and cmp, thus it is better if the order of those operands
2409/// match.
2410/// \return true if Op0 and Op1 should be swapped.
2411static bool swapMayExposeCSEOpportunities(const Value * Op0,
2412 const Value * Op1) {
2413 // Filter out pointer value as those cannot appears directly in subtract.
2414 // FIXME: we may want to go through inttoptrs or bitcasts.
2415 if (Op0->getType()->isPointerTy())
2416 return false;
2417 // Count every uses of both Op0 and Op1 in a subtract.
2418 // Each time Op0 is the first operand, count -1: swapping is bad, the
2419 // subtract has already the same layout as the compare.
2420 // Each time Op0 is the second operand, count +1: swapping is good, the
Alp Tokercb402912014-01-24 17:20:08 +00002421 // subtract has a different layout as the compare.
Quentin Colombet5ab55552013-09-09 20:56:48 +00002422 // At the end, if the benefit is greater than 0, Op0 should come second to
2423 // expose more CSE opportunities.
2424 int GlobalSwapBenefits = 0;
Chandler Carruthcdf47882014-03-09 03:16:01 +00002425 for (const User *U : Op0->users()) {
2426 const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(U);
Quentin Colombet5ab55552013-09-09 20:56:48 +00002427 if (!BinOp || BinOp->getOpcode() != Instruction::Sub)
2428 continue;
2429 // If Op0 is the first argument, this is not beneficial to swap the
2430 // arguments.
2431 int LocalSwapBenefits = -1;
2432 unsigned Op1Idx = 1;
2433 if (BinOp->getOperand(Op1Idx) == Op0) {
2434 Op1Idx = 0;
2435 LocalSwapBenefits = 1;
2436 }
2437 if (BinOp->getOperand(Op1Idx) != Op1)
2438 continue;
2439 GlobalSwapBenefits += LocalSwapBenefits;
2440 }
2441 return GlobalSwapBenefits > 0;
2442}
2443
Chris Lattner2188e402010-01-04 07:37:31 +00002444Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
2445 bool Changed = false;
Chris Lattner9306ffa2010-02-01 19:54:45 +00002446 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Quentin Colombet5ab55552013-09-09 20:56:48 +00002447 unsigned Op0Cplxity = getComplexity(Op0);
2448 unsigned Op1Cplxity = getComplexity(Op1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002449
Chris Lattner2188e402010-01-04 07:37:31 +00002450 /// Orders the operands of the compare so that they are listed from most
2451 /// complex to least complex. This puts constants before unary operators,
2452 /// before binary operators.
Quentin Colombet5ab55552013-09-09 20:56:48 +00002453 if (Op0Cplxity < Op1Cplxity ||
2454 (Op0Cplxity == Op1Cplxity &&
2455 swapMayExposeCSEOpportunities(Op0, Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00002456 I.swapOperands();
Chris Lattner9306ffa2010-02-01 19:54:45 +00002457 std::swap(Op0, Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00002458 Changed = true;
2459 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002460
Hal Finkel60db0582014-09-07 18:57:58 +00002461 if (Value *V = SimplifyICmpInst(I.getPredicate(), Op0, Op1, DL, TLI, DT, AT))
Chris Lattner2188e402010-01-04 07:37:31 +00002462 return ReplaceInstUsesWith(I, V);
Jim Grosbach129c52a2011-09-30 18:09:53 +00002463
Pete Cooperbc5c5242011-12-01 03:58:40 +00002464 // comparing -val or val with non-zero is the same as just comparing val
Pete Cooperfdddc272011-12-01 19:13:26 +00002465 // ie, abs(val) != 0 -> val != 0
Pete Cooperbc5c5242011-12-01 03:58:40 +00002466 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero()))
2467 {
Pete Cooperfdddc272011-12-01 19:13:26 +00002468 Value *Cond, *SelectTrue, *SelectFalse;
2469 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
Pete Cooperbc5c5242011-12-01 03:58:40 +00002470 m_Value(SelectFalse)))) {
Pete Cooperfdddc272011-12-01 19:13:26 +00002471 if (Value *V = dyn_castNegVal(SelectTrue)) {
2472 if (V == SelectFalse)
2473 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
2474 }
2475 else if (Value *V = dyn_castNegVal(SelectFalse)) {
2476 if (V == SelectTrue)
2477 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
Pete Cooperbc5c5242011-12-01 03:58:40 +00002478 }
2479 }
2480 }
2481
Chris Lattner229907c2011-07-18 04:54:35 +00002482 Type *Ty = Op0->getType();
Chris Lattner2188e402010-01-04 07:37:31 +00002483
2484 // icmp's with boolean values can always be turned into bitwise operations
Duncan Sands9dff9be2010-02-15 16:12:20 +00002485 if (Ty->isIntegerTy(1)) {
Chris Lattner2188e402010-01-04 07:37:31 +00002486 switch (I.getPredicate()) {
2487 default: llvm_unreachable("Invalid icmp instruction!");
2488 case ICmpInst::ICMP_EQ: { // icmp eq i1 A, B -> ~(A^B)
2489 Value *Xor = Builder->CreateXor(Op0, Op1, I.getName()+"tmp");
2490 return BinaryOperator::CreateNot(Xor);
2491 }
2492 case ICmpInst::ICMP_NE: // icmp eq i1 A, B -> A^B
2493 return BinaryOperator::CreateXor(Op0, Op1);
2494
2495 case ICmpInst::ICMP_UGT:
2496 std::swap(Op0, Op1); // Change icmp ugt -> icmp ult
2497 // FALL THROUGH
2498 case ICmpInst::ICMP_ULT:{ // icmp ult i1 A, B -> ~A & B
2499 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2500 return BinaryOperator::CreateAnd(Not, Op1);
2501 }
2502 case ICmpInst::ICMP_SGT:
2503 std::swap(Op0, Op1); // Change icmp sgt -> icmp slt
2504 // FALL THROUGH
2505 case ICmpInst::ICMP_SLT: { // icmp slt i1 A, B -> A & ~B
2506 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2507 return BinaryOperator::CreateAnd(Not, Op0);
2508 }
2509 case ICmpInst::ICMP_UGE:
2510 std::swap(Op0, Op1); // Change icmp uge -> icmp ule
2511 // FALL THROUGH
2512 case ICmpInst::ICMP_ULE: { // icmp ule i1 A, B -> ~A | B
2513 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2514 return BinaryOperator::CreateOr(Not, Op1);
2515 }
2516 case ICmpInst::ICMP_SGE:
2517 std::swap(Op0, Op1); // Change icmp sge -> icmp sle
2518 // FALL THROUGH
2519 case ICmpInst::ICMP_SLE: { // icmp sle i1 A, B -> A | ~B
2520 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2521 return BinaryOperator::CreateOr(Not, Op0);
2522 }
2523 }
2524 }
2525
2526 unsigned BitWidth = 0;
Chris Lattner5e0c0c72010-12-19 19:37:52 +00002527 if (Ty->isIntOrIntVectorTy())
Chris Lattner2188e402010-01-04 07:37:31 +00002528 BitWidth = Ty->getScalarSizeInBits();
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002529 else if (DL) // Pointers require DL info to get their size.
2530 BitWidth = DL->getTypeSizeInBits(Ty->getScalarType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00002531
Chris Lattner2188e402010-01-04 07:37:31 +00002532 bool isSignBit = false;
2533
2534 // See if we are doing a comparison with a constant.
2535 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Craig Topperf40110f2014-04-25 05:29:35 +00002536 Value *A = nullptr, *B = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002537
Owen Anderson1294ea72010-12-17 18:08:00 +00002538 // Match the following pattern, which is a common idiom when writing
2539 // overflow-safe integer arithmetic function. The source performs an
2540 // addition in wider type, and explicitly checks for overflow using
2541 // comparisons against INT_MIN and INT_MAX. Simplify this by using the
2542 // sadd_with_overflow intrinsic.
Chris Lattneree61c1d2010-12-19 17:52:50 +00002543 //
2544 // TODO: This could probably be generalized to handle other overflow-safe
Jim Grosbach129c52a2011-09-30 18:09:53 +00002545 // operations if we worked out the formulas to compute the appropriate
Owen Anderson1294ea72010-12-17 18:08:00 +00002546 // magic constants.
Jim Grosbach129c52a2011-09-30 18:09:53 +00002547 //
Chris Lattneree61c1d2010-12-19 17:52:50 +00002548 // sum = a + b
2549 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8
Owen Anderson1294ea72010-12-17 18:08:00 +00002550 {
Chris Lattneree61c1d2010-12-19 17:52:50 +00002551 ConstantInt *CI2; // I = icmp ugt (add (add A, B), CI2), CI
Owen Anderson1294ea72010-12-17 18:08:00 +00002552 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
Chris Lattneree61c1d2010-12-19 17:52:50 +00002553 match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
Chris Lattnerce2995a2010-12-19 18:38:44 +00002554 if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this))
Chris Lattneree61c1d2010-12-19 17:52:50 +00002555 return Res;
Owen Anderson1294ea72010-12-17 18:08:00 +00002556 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002557
Chris Lattner2188e402010-01-04 07:37:31 +00002558 // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B)
2559 if (I.isEquality() && CI->isZero() &&
2560 match(Op0, m_Sub(m_Value(A), m_Value(B)))) {
2561 // (icmp cond A B) if cond is equality
2562 return new ICmpInst(I.getPredicate(), A, B);
2563 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002564
Chris Lattner2188e402010-01-04 07:37:31 +00002565 // If we have an icmp le or icmp ge instruction, turn it into the
2566 // appropriate icmp lt or icmp gt instruction. This allows us to rely on
2567 // them being folded in the code below. The SimplifyICmpInst code has
2568 // already handled the edge cases for us, so we just assert on them.
2569 switch (I.getPredicate()) {
2570 default: break;
2571 case ICmpInst::ICMP_ULE:
2572 assert(!CI->isMaxValue(false)); // A <=u MAX -> TRUE
2573 return new ICmpInst(ICmpInst::ICMP_ULT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002574 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00002575 case ICmpInst::ICMP_SLE:
2576 assert(!CI->isMaxValue(true)); // A <=s MAX -> TRUE
2577 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002578 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00002579 case ICmpInst::ICMP_UGE:
Nick Lewycky6b4454192011-02-28 06:20:05 +00002580 assert(!CI->isMinValue(false)); // A >=u MIN -> TRUE
Chris Lattner2188e402010-01-04 07:37:31 +00002581 return new ICmpInst(ICmpInst::ICMP_UGT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002582 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002583 case ICmpInst::ICMP_SGE:
Nick Lewycky6b4454192011-02-28 06:20:05 +00002584 assert(!CI->isMinValue(true)); // A >=s MIN -> TRUE
Chris Lattner2188e402010-01-04 07:37:31 +00002585 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002586 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002587 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002588
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00002589 if (I.isEquality()) {
2590 ConstantInt *CI2;
2591 if (match(Op0, m_AShr(m_ConstantInt(CI2), m_Value(A))) ||
2592 match(Op0, m_LShr(m_ConstantInt(CI2), m_Value(A)))) {
David Majnemer59939ac2014-10-19 08:23:08 +00002593 // (icmp eq/ne (ashr/lshr const2, A), const1)
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00002594 return FoldICmpCstShrCst(I, Op0, A, CI, CI2);
2595 }
David Majnemer59939ac2014-10-19 08:23:08 +00002596 if (match(Op0, m_Shl(m_ConstantInt(CI2), m_Value(A)))) {
2597 // (icmp eq/ne (shl const2, A), const1)
2598 return FoldICmpCstShlCst(I, Op0, A, CI, CI2);
2599 }
Suyog Sarda3a8c2c12014-07-22 19:19:36 +00002600 }
2601
Chris Lattner2188e402010-01-04 07:37:31 +00002602 // If this comparison is a normal comparison, it demands all
2603 // bits, if it is a sign bit comparison, it only demands the sign bit.
2604 bool UnusedBit;
2605 isSignBit = isSignBitCheck(I.getPredicate(), CI, UnusedBit);
2606 }
2607
2608 // See if we can fold the comparison based on range information we can get
2609 // by checking whether bits are known to be zero or one in the input.
2610 if (BitWidth != 0) {
2611 APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0);
2612 APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0);
2613
2614 if (SimplifyDemandedBits(I.getOperandUse(0),
Owen Andersond490c2d2011-01-11 00:36:45 +00002615 DemandedBitsLHSMask(I, BitWidth, isSignBit),
Chris Lattner2188e402010-01-04 07:37:31 +00002616 Op0KnownZero, Op0KnownOne, 0))
2617 return &I;
2618 if (SimplifyDemandedBits(I.getOperandUse(1),
2619 APInt::getAllOnesValue(BitWidth),
2620 Op1KnownZero, Op1KnownOne, 0))
2621 return &I;
2622
2623 // Given the known and unknown bits, compute a range that the LHS could be
2624 // in. Compute the Min, Max and RHS values based on the known bits. For the
2625 // EQ and NE we use unsigned values.
2626 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
2627 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
2628 if (I.isSigned()) {
2629 ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2630 Op0Min, Op0Max);
2631 ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2632 Op1Min, Op1Max);
2633 } else {
2634 ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2635 Op0Min, Op0Max);
2636 ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2637 Op1Min, Op1Max);
2638 }
2639
2640 // If Min and Max are known to be the same, then SimplifyDemandedBits
2641 // figured out that the LHS is a constant. Just constant fold this now so
2642 // that code below can assume that Min != Max.
2643 if (!isa<Constant>(Op0) && Op0Min == Op0Max)
2644 return new ICmpInst(I.getPredicate(),
Nick Lewycky92db8e82011-03-06 03:36:19 +00002645 ConstantInt::get(Op0->getType(), Op0Min), Op1);
Chris Lattner2188e402010-01-04 07:37:31 +00002646 if (!isa<Constant>(Op1) && Op1Min == Op1Max)
2647 return new ICmpInst(I.getPredicate(), Op0,
Nick Lewycky92db8e82011-03-06 03:36:19 +00002648 ConstantInt::get(Op1->getType(), Op1Min));
Chris Lattner2188e402010-01-04 07:37:31 +00002649
2650 // Based on the range information we know about the LHS, see if we can
Nick Lewycky6b4454192011-02-28 06:20:05 +00002651 // simplify this comparison. For example, (x&4) < 8 is always true.
Chris Lattner2188e402010-01-04 07:37:31 +00002652 switch (I.getPredicate()) {
2653 default: llvm_unreachable("Unknown icmp opcode!");
Chris Lattnerf7e89612010-11-21 06:44:42 +00002654 case ICmpInst::ICMP_EQ: {
Chris Lattner2188e402010-01-04 07:37:31 +00002655 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Nick Lewycky92db8e82011-03-06 03:36:19 +00002656 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Jim Grosbach129c52a2011-09-30 18:09:53 +00002657
Chris Lattnerf7e89612010-11-21 06:44:42 +00002658 // If all bits are known zero except for one, then we know at most one
2659 // bit is set. If the comparison is against zero, then this is a check
2660 // to see if *that* bit is set.
2661 APInt Op0KnownZeroInverted = ~Op0KnownZero;
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002662 if (~Op1KnownZero == 0) {
Chris Lattnerf7e89612010-11-21 06:44:42 +00002663 // If the LHS is an AND with the same constant, look through it.
Craig Topperf40110f2014-04-25 05:29:35 +00002664 Value *LHS = nullptr;
2665 ConstantInt *LHSC = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002666 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2667 LHSC->getValue() != Op0KnownZeroInverted)
2668 LHS = Op0;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002669
Chris Lattnerf7e89612010-11-21 06:44:42 +00002670 // 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 +00002671 // then turn "((1 << x)&8) == 0" into "x != 3".
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002672 // or turn "((1 << x)&7) == 0" into "x > 2".
Craig Topperf40110f2014-04-25 05:29:35 +00002673 Value *X = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002674 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002675 APInt ValToCheck = Op0KnownZeroInverted;
2676 if (ValToCheck.isPowerOf2()) {
2677 unsigned CmpVal = ValToCheck.countTrailingZeros();
2678 return new ICmpInst(ICmpInst::ICMP_NE, X,
2679 ConstantInt::get(X->getType(), CmpVal));
2680 } else if ((++ValToCheck).isPowerOf2()) {
2681 unsigned CmpVal = ValToCheck.countTrailingZeros() - 1;
2682 return new ICmpInst(ICmpInst::ICMP_UGT, X,
2683 ConstantInt::get(X->getType(), CmpVal));
2684 }
Chris Lattnerf7e89612010-11-21 06:44:42 +00002685 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002686
Chris Lattnerf7e89612010-11-21 06:44:42 +00002687 // 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 +00002688 // then turn "((8 >>u x)&1) == 0" into "x != 3".
Chris Lattner98457102011-02-10 05:23:05 +00002689 const APInt *CI;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002690 if (Op0KnownZeroInverted == 1 &&
Chris Lattner98457102011-02-10 05:23:05 +00002691 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattnere5afa152010-11-23 02:42:04 +00002692 return new ICmpInst(ICmpInst::ICMP_NE, X,
Chris Lattner98457102011-02-10 05:23:05 +00002693 ConstantInt::get(X->getType(),
2694 CI->countTrailingZeros()));
Chris Lattnerf7e89612010-11-21 06:44:42 +00002695 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002696
Chris Lattner2188e402010-01-04 07:37:31 +00002697 break;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002698 }
2699 case ICmpInst::ICMP_NE: {
Chris Lattner2188e402010-01-04 07:37:31 +00002700 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Nick Lewycky92db8e82011-03-06 03:36:19 +00002701 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Jim Grosbach129c52a2011-09-30 18:09:53 +00002702
Chris Lattnerf7e89612010-11-21 06:44:42 +00002703 // If all bits are known zero except for one, then we know at most one
2704 // bit is set. If the comparison is against zero, then this is a check
2705 // to see if *that* bit is set.
2706 APInt Op0KnownZeroInverted = ~Op0KnownZero;
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002707 if (~Op1KnownZero == 0) {
Chris Lattnerf7e89612010-11-21 06:44:42 +00002708 // If the LHS is an AND with the same constant, look through it.
Craig Topperf40110f2014-04-25 05:29:35 +00002709 Value *LHS = nullptr;
2710 ConstantInt *LHSC = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002711 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2712 LHSC->getValue() != Op0KnownZeroInverted)
2713 LHS = Op0;
Jim Grosbach129c52a2011-09-30 18:09:53 +00002714
Chris Lattnerf7e89612010-11-21 06:44:42 +00002715 // 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 +00002716 // then turn "((1 << x)&8) != 0" into "x == 3".
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002717 // or turn "((1 << x)&7) != 0" into "x < 3".
Craig Topperf40110f2014-04-25 05:29:35 +00002718 Value *X = nullptr;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002719 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
Dinesh Dwivedice5d35a2014-06-02 07:57:24 +00002720 APInt ValToCheck = Op0KnownZeroInverted;
2721 if (ValToCheck.isPowerOf2()) {
2722 unsigned CmpVal = ValToCheck.countTrailingZeros();
2723 return new ICmpInst(ICmpInst::ICMP_EQ, X,
2724 ConstantInt::get(X->getType(), CmpVal));
2725 } else if ((++ValToCheck).isPowerOf2()) {
2726 unsigned CmpVal = ValToCheck.countTrailingZeros();
2727 return new ICmpInst(ICmpInst::ICMP_ULT, X,
2728 ConstantInt::get(X->getType(), CmpVal));
2729 }
Chris Lattnerf7e89612010-11-21 06:44:42 +00002730 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002731
Chris Lattnerf7e89612010-11-21 06:44:42 +00002732 // 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 +00002733 // then turn "((8 >>u x)&1) != 0" into "x == 3".
Chris Lattner98457102011-02-10 05:23:05 +00002734 const APInt *CI;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002735 if (Op0KnownZeroInverted == 1 &&
Chris Lattner98457102011-02-10 05:23:05 +00002736 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattnere5afa152010-11-23 02:42:04 +00002737 return new ICmpInst(ICmpInst::ICMP_EQ, X,
Chris Lattner98457102011-02-10 05:23:05 +00002738 ConstantInt::get(X->getType(),
2739 CI->countTrailingZeros()));
Chris Lattnerf7e89612010-11-21 06:44:42 +00002740 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002741
Chris Lattner2188e402010-01-04 07:37:31 +00002742 break;
Chris Lattnerf7e89612010-11-21 06:44:42 +00002743 }
Chris Lattner2188e402010-01-04 07:37:31 +00002744 case ICmpInst::ICMP_ULT:
2745 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002746 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002747 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002748 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002749 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
2750 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2751 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2752 if (Op1Max == Op0Min+1) // A <u C -> A == C-1 if min(A)+1 == C
2753 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002754 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002755
2756 // (x <u 2147483648) -> (x >s -1) -> true if sign bit clear
2757 if (CI->isMinValue(true))
2758 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
2759 Constant::getAllOnesValue(Op0->getType()));
2760 }
2761 break;
2762 case ICmpInst::ICMP_UGT:
2763 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002764 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002765 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002766 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002767
2768 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
2769 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2770 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2771 if (Op1Min == Op0Max-1) // A >u C -> A == C+1 if max(a)-1 == C
2772 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002773 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00002774
2775 // (x >u 2147483647) -> (x <s 0) -> true if sign bit set
2776 if (CI->isMaxValue(true))
2777 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
2778 Constant::getNullValue(Op0->getType()));
2779 }
2780 break;
2781 case ICmpInst::ICMP_SLT:
2782 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002783 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002784 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002785 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002786 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
2787 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2788 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2789 if (Op1Max == Op0Min+1) // A <s C -> A == C-1 if min(A)+1 == C
2790 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002791 Builder->getInt(CI->getValue()-1));
Chris Lattner2188e402010-01-04 07:37:31 +00002792 }
2793 break;
2794 case ICmpInst::ICMP_SGT:
2795 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002796 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002797 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002798 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002799
2800 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
2801 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2802 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2803 if (Op1Min == Op0Max-1) // A >s C -> A == C+1 if max(A)-1 == C
2804 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszakbddea112013-06-06 20:18:46 +00002805 Builder->getInt(CI->getValue()+1));
Chris Lattner2188e402010-01-04 07:37:31 +00002806 }
2807 break;
2808 case ICmpInst::ICMP_SGE:
2809 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
2810 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002811 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002812 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002813 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002814 break;
2815 case ICmpInst::ICMP_SLE:
2816 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
2817 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002818 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002819 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002820 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002821 break;
2822 case ICmpInst::ICMP_UGE:
2823 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
2824 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002825 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002826 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002827 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002828 break;
2829 case ICmpInst::ICMP_ULE:
2830 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
2831 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002832 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002833 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
Nick Lewycky92db8e82011-03-06 03:36:19 +00002834 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner2188e402010-01-04 07:37:31 +00002835 break;
2836 }
2837
2838 // Turn a signed comparison into an unsigned one if both operands
2839 // are known to have the same sign.
2840 if (I.isSigned() &&
2841 ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) ||
2842 (Op0KnownOne.isNegative() && Op1KnownOne.isNegative())))
2843 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
2844 }
2845
2846 // Test if the ICmpInst instruction is used exclusively by a select as
2847 // part of a minimum or maximum operation. If so, refrain from doing
2848 // any other folding. This helps out other analyses which understand
2849 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
2850 // and CodeGen. And in this case, at least one of the comparison
2851 // operands has at least one user besides the compare (the select),
2852 // which would often largely negate the benefit of folding anyway.
2853 if (I.hasOneUse())
Chandler Carruthcdf47882014-03-09 03:16:01 +00002854 if (SelectInst *SI = dyn_cast<SelectInst>(*I.user_begin()))
Chris Lattner2188e402010-01-04 07:37:31 +00002855 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
2856 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
Craig Topperf40110f2014-04-25 05:29:35 +00002857 return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002858
2859 // See if we are doing a comparison between a constant and an instruction that
2860 // can be folded into the comparison.
2861 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00002862 // Since the RHS is a ConstantInt (CI), if the left hand side is an
2863 // instruction, see if that instruction also has constants so that the
2864 // instruction can be folded into the icmp
Chris Lattner2188e402010-01-04 07:37:31 +00002865 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2866 if (Instruction *Res = visitICmpInstWithInstAndIntCst(I, LHSI, CI))
2867 return Res;
2868 }
2869
2870 // Handle icmp with constant (but not simple integer constant) RHS
2871 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
2872 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2873 switch (LHSI->getOpcode()) {
2874 case Instruction::GetElementPtr:
2875 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
2876 if (RHSC->isNullValue() &&
2877 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
2878 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2879 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2880 break;
2881 case Instruction::PHI:
2882 // Only fold icmp into the PHI if the phi and icmp are in the same
2883 // block. If in the same block, we're encouraging jump threading. If
2884 // not, we are just pessimizing the code by making an i1 phi.
2885 if (LHSI->getParent() == I.getParent())
Chris Lattnerea7131a2011-01-16 05:14:26 +00002886 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner2188e402010-01-04 07:37:31 +00002887 return NV;
2888 break;
2889 case Instruction::Select: {
2890 // If either operand of the select is a constant, we can fold the
2891 // comparison into the select arms, which will cause one to be
2892 // constant folded and the select turned into a bitwise or.
Craig Topperf40110f2014-04-25 05:29:35 +00002893 Value *Op1 = nullptr, *Op2 = nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00002894 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1)))
2895 Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2896 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2)))
2897 Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2898
2899 // We only want to perform this transformation if it will not lead to
2900 // additional code. This is true if either both sides of the select
2901 // fold to a constant (in which case the icmp is replaced with a select
2902 // which will usually simplify) or this is the only user of the
2903 // select (in which case we are trading a select+icmp for a simpler
Justin Bogner894eff72014-10-08 16:30:22 +00002904 // select+icmp).
2905 if ((Op1 && Op2) || (LHSI->hasOneUse() && (Op1 || Op2))) {
Chris Lattner2188e402010-01-04 07:37:31 +00002906 if (!Op1)
2907 Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1),
2908 RHSC, I.getName());
2909 if (!Op2)
2910 Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2),
2911 RHSC, I.getName());
2912 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
2913 }
2914 break;
2915 }
Chris Lattner2188e402010-01-04 07:37:31 +00002916 case Instruction::IntToPtr:
2917 // icmp pred inttoptr(X), null -> icmp pred X, 0
Rafael Espindola37dc9e12014-02-21 00:06:31 +00002918 if (RHSC->isNullValue() && DL &&
2919 DL->getIntPtrType(RHSC->getType()) ==
Chris Lattner2188e402010-01-04 07:37:31 +00002920 LHSI->getOperand(0)->getType())
2921 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2922 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2923 break;
2924
2925 case Instruction::Load:
2926 // Try to optimize things like "A[i] > 4" to index computations.
2927 if (GetElementPtrInst *GEP =
2928 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
2929 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
2930 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
2931 !cast<LoadInst>(LHSI)->isVolatile())
2932 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
2933 return Res;
2934 }
2935 break;
2936 }
2937 }
2938
2939 // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
2940 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
2941 if (Instruction *NI = FoldGEPICmp(GEP, Op1, I.getPredicate(), I))
2942 return NI;
2943 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
2944 if (Instruction *NI = FoldGEPICmp(GEP, Op0,
2945 ICmpInst::getSwappedPredicate(I.getPredicate()), I))
2946 return NI;
2947
2948 // Test to see if the operands of the icmp are casted versions of other
2949 // values. If the ptr->ptr cast can be stripped off both arguments, we do so
2950 // now.
2951 if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
Jim Grosbach129c52a2011-09-30 18:09:53 +00002952 if (Op0->getType()->isPointerTy() &&
2953 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
Chris Lattner2188e402010-01-04 07:37:31 +00002954 // We keep moving the cast from the left operand over to the right
2955 // operand, where it can often be eliminated completely.
2956 Op0 = CI->getOperand(0);
2957
2958 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
2959 // so eliminate it as well.
2960 if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
2961 Op1 = CI2->getOperand(0);
2962
2963 // If Op1 is a constant, we can fold the cast into the constant.
2964 if (Op0->getType() != Op1->getType()) {
2965 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
2966 Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
2967 } else {
2968 // Otherwise, cast the RHS right before the icmp
2969 Op1 = Builder->CreateBitCast(Op1, Op0->getType());
2970 }
2971 }
2972 return new ICmpInst(I.getPredicate(), Op0, Op1);
2973 }
2974 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00002975
Chris Lattner2188e402010-01-04 07:37:31 +00002976 if (isa<CastInst>(Op0)) {
2977 // Handle the special case of: icmp (cast bool to X), <cst>
2978 // This comes up when you have code like
2979 // int X = A < B;
2980 // if (X) ...
2981 // For generality, we handle any zero-extension of any operand comparison
2982 // with a constant or another cast from the same type.
2983 if (isa<Constant>(Op1) || isa<CastInst>(Op1))
2984 if (Instruction *R = visitICmpInstWithCastAndCast(I))
2985 return R;
2986 }
Chris Lattner2188e402010-01-04 07:37:31 +00002987
Duncan Sandse5220012011-02-17 07:46:37 +00002988 // Special logic for binary operators.
2989 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
2990 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
2991 if (BO0 || BO1) {
2992 CmpInst::Predicate Pred = I.getPredicate();
2993 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
2994 if (BO0 && isa<OverflowingBinaryOperator>(BO0))
2995 NoOp0WrapProblem = ICmpInst::isEquality(Pred) ||
2996 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
2997 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
2998 if (BO1 && isa<OverflowingBinaryOperator>(BO1))
2999 NoOp1WrapProblem = ICmpInst::isEquality(Pred) ||
3000 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
3001 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
3002
3003 // Analyze the case when either Op0 or Op1 is an add instruction.
3004 // 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 +00003005 Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
Duncan Sandse5220012011-02-17 07:46:37 +00003006 if (BO0 && BO0->getOpcode() == Instruction::Add)
3007 A = BO0->getOperand(0), B = BO0->getOperand(1);
3008 if (BO1 && BO1->getOpcode() == Instruction::Add)
3009 C = BO1->getOperand(0), D = BO1->getOperand(1);
3010
3011 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
3012 if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
3013 return new ICmpInst(Pred, A == Op1 ? B : A,
3014 Constant::getNullValue(Op1->getType()));
3015
3016 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
3017 if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
3018 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
3019 C == Op0 ? D : C);
3020
Duncan Sands84653b32011-02-18 16:25:37 +00003021 // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandse5220012011-02-17 07:46:37 +00003022 if (A && C && (A == C || A == D || B == C || B == D) &&
3023 NoOp0WrapProblem && NoOp1WrapProblem &&
3024 // Try not to increase register pressure.
3025 BO0->hasOneUse() && BO1->hasOneUse()) {
3026 // Determine Y and Z in the form icmp (X+Y), (X+Z).
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003027 Value *Y, *Z;
3028 if (A == C) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003029 // C + B == C + D -> B == D
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003030 Y = B;
3031 Z = D;
3032 } else if (A == D) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003033 // D + B == C + D -> B == C
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003034 Y = B;
3035 Z = C;
3036 } else if (B == C) {
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003037 // A + C == C + D -> A == D
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003038 Y = A;
3039 Z = D;
Duncan Sandsd7d8c092012-11-16 20:53:08 +00003040 } else {
3041 assert(B == D);
3042 // A + D == C + D -> A == C
Duncan Sands1d3acdd2012-11-16 18:55:49 +00003043 Y = A;
3044 Z = C;
3045 }
Duncan Sandse5220012011-02-17 07:46:37 +00003046 return new ICmpInst(Pred, Y, Z);
3047 }
3048
David Majnemerb81cd632013-04-11 20:05:46 +00003049 // icmp slt (X + -1), Y -> icmp sle X, Y
3050 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
3051 match(B, m_AllOnes()))
3052 return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
3053
3054 // icmp sge (X + -1), Y -> icmp sgt X, Y
3055 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
3056 match(B, m_AllOnes()))
3057 return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
3058
3059 // icmp sle (X + 1), Y -> icmp slt X, Y
3060 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE &&
3061 match(B, m_One()))
3062 return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
3063
3064 // icmp sgt (X + 1), Y -> icmp sge X, Y
3065 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT &&
3066 match(B, m_One()))
3067 return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
3068
3069 // if C1 has greater magnitude than C2:
3070 // icmp (X + C1), (Y + C2) -> icmp (X + C3), Y
3071 // s.t. C3 = C1 - C2
3072 //
3073 // if C2 has greater magnitude than C1:
3074 // icmp (X + C1), (Y + C2) -> icmp X, (Y + C3)
3075 // s.t. C3 = C2 - C1
3076 if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
3077 (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
3078 if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
3079 if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
3080 const APInt &AP1 = C1->getValue();
3081 const APInt &AP2 = C2->getValue();
3082 if (AP1.isNegative() == AP2.isNegative()) {
3083 APInt AP1Abs = C1->getValue().abs();
3084 APInt AP2Abs = C2->getValue().abs();
3085 if (AP1Abs.uge(AP2Abs)) {
3086 ConstantInt *C3 = Builder->getInt(AP1 - AP2);
3087 Value *NewAdd = Builder->CreateNSWAdd(A, C3);
3088 return new ICmpInst(Pred, NewAdd, C);
3089 } else {
3090 ConstantInt *C3 = Builder->getInt(AP2 - AP1);
3091 Value *NewAdd = Builder->CreateNSWAdd(C, C3);
3092 return new ICmpInst(Pred, A, NewAdd);
3093 }
3094 }
3095 }
3096
3097
Duncan Sandse5220012011-02-17 07:46:37 +00003098 // Analyze the case when either Op0 or Op1 is a sub instruction.
3099 // 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 +00003100 A = nullptr; B = nullptr; C = nullptr; D = nullptr;
Duncan Sandse5220012011-02-17 07:46:37 +00003101 if (BO0 && BO0->getOpcode() == Instruction::Sub)
3102 A = BO0->getOperand(0), B = BO0->getOperand(1);
3103 if (BO1 && BO1->getOpcode() == Instruction::Sub)
3104 C = BO1->getOperand(0), D = BO1->getOperand(1);
3105
Duncan Sands84653b32011-02-18 16:25:37 +00003106 // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
3107 if (A == Op1 && NoOp0WrapProblem)
3108 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
3109
3110 // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
3111 if (C == Op0 && NoOp1WrapProblem)
3112 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
3113
3114 // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandse5220012011-02-17 07:46:37 +00003115 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
3116 // Try not to increase register pressure.
3117 BO0->hasOneUse() && BO1->hasOneUse())
3118 return new ICmpInst(Pred, A, C);
3119
Duncan Sands84653b32011-02-18 16:25:37 +00003120 // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
3121 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
3122 // Try not to increase register pressure.
3123 BO0->hasOneUse() && BO1->hasOneUse())
3124 return new ICmpInst(Pred, D, B);
3125
David Majnemer186c9422014-05-15 00:02:20 +00003126 // icmp (0-X) < cst --> x > -cst
3127 if (NoOp0WrapProblem && ICmpInst::isSigned(Pred)) {
3128 Value *X;
3129 if (match(BO0, m_Neg(m_Value(X))))
3130 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
3131 if (!RHSC->isMinValue(/*isSigned=*/true))
3132 return new ICmpInst(I.getSwappedPredicate(), X,
3133 ConstantExpr::getNeg(RHSC));
3134 }
3135
Craig Topperf40110f2014-04-25 05:29:35 +00003136 BinaryOperator *SRem = nullptr;
Nick Lewyckyafc80982011-03-08 06:29:47 +00003137 // icmp (srem X, Y), Y
Nick Lewycky25cc3382011-03-05 04:28:48 +00003138 if (BO0 && BO0->getOpcode() == Instruction::SRem &&
3139 Op1 == BO0->getOperand(1))
3140 SRem = BO0;
Nick Lewyckyafc80982011-03-08 06:29:47 +00003141 // icmp Y, (srem X, Y)
Nick Lewycky25cc3382011-03-05 04:28:48 +00003142 else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
3143 Op0 == BO1->getOperand(1))
3144 SRem = BO1;
3145 if (SRem) {
3146 // We don't check hasOneUse to avoid increasing register pressure because
3147 // the value we use is the same value this instruction was already using.
3148 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
3149 default: break;
3150 case ICmpInst::ICMP_EQ:
Nick Lewycky92db8e82011-03-06 03:36:19 +00003151 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Nick Lewycky25cc3382011-03-05 04:28:48 +00003152 case ICmpInst::ICMP_NE:
Nick Lewycky92db8e82011-03-06 03:36:19 +00003153 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Nick Lewycky25cc3382011-03-05 04:28:48 +00003154 case ICmpInst::ICMP_SGT:
3155 case ICmpInst::ICMP_SGE:
3156 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
3157 Constant::getAllOnesValue(SRem->getType()));
3158 case ICmpInst::ICMP_SLT:
3159 case ICmpInst::ICMP_SLE:
3160 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
3161 Constant::getNullValue(SRem->getType()));
3162 }
3163 }
3164
Duncan Sandse5220012011-02-17 07:46:37 +00003165 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() &&
3166 BO0->hasOneUse() && BO1->hasOneUse() &&
3167 BO0->getOperand(1) == BO1->getOperand(1)) {
3168 switch (BO0->getOpcode()) {
3169 default: break;
3170 case Instruction::Add:
3171 case Instruction::Sub:
3172 case Instruction::Xor:
3173 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
3174 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3175 BO1->getOperand(0));
3176 // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b
3177 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
3178 if (CI->getValue().isSignBit()) {
3179 ICmpInst::Predicate Pred = I.isSigned()
3180 ? I.getUnsignedPredicate()
3181 : I.getSignedPredicate();
3182 return new ICmpInst(Pred, BO0->getOperand(0),
3183 BO1->getOperand(0));
Chris Lattner2188e402010-01-04 07:37:31 +00003184 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003185
Chris Lattnerb1a15122011-07-15 06:08:15 +00003186 if (CI->isMaxValue(true)) {
Duncan Sandse5220012011-02-17 07:46:37 +00003187 ICmpInst::Predicate Pred = I.isSigned()
3188 ? I.getUnsignedPredicate()
3189 : I.getSignedPredicate();
3190 Pred = I.getSwappedPredicate(Pred);
3191 return new ICmpInst(Pred, BO0->getOperand(0),
3192 BO1->getOperand(0));
3193 }
Chris Lattner2188e402010-01-04 07:37:31 +00003194 }
Duncan Sandse5220012011-02-17 07:46:37 +00003195 break;
3196 case Instruction::Mul:
3197 if (!I.isEquality())
3198 break;
3199
3200 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
3201 // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask
3202 // Mask = -1 >> count-trailing-zeros(Cst).
3203 if (!CI->isZero() && !CI->isOne()) {
3204 const APInt &AP = CI->getValue();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003205 ConstantInt *Mask = ConstantInt::get(I.getContext(),
Duncan Sandse5220012011-02-17 07:46:37 +00003206 APInt::getLowBitsSet(AP.getBitWidth(),
3207 AP.getBitWidth() -
3208 AP.countTrailingZeros()));
3209 Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask);
3210 Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask);
3211 return new ICmpInst(I.getPredicate(), And1, And2);
3212 }
3213 }
3214 break;
Nick Lewycky9719a712011-03-05 05:19:11 +00003215 case Instruction::UDiv:
3216 case Instruction::LShr:
3217 if (I.isSigned())
3218 break;
3219 // fall-through
3220 case Instruction::SDiv:
3221 case Instruction::AShr:
Eli Friedman8a20e662011-05-05 21:59:18 +00003222 if (!BO0->isExact() || !BO1->isExact())
Nick Lewycky9719a712011-03-05 05:19:11 +00003223 break;
3224 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3225 BO1->getOperand(0));
3226 case Instruction::Shl: {
3227 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
3228 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
3229 if (!NUW && !NSW)
3230 break;
3231 if (!NSW && I.isSigned())
3232 break;
3233 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
3234 BO1->getOperand(0));
3235 }
Chris Lattner2188e402010-01-04 07:37:31 +00003236 }
3237 }
3238 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003239
Chris Lattner2188e402010-01-04 07:37:31 +00003240 { Value *A, *B;
David Majnemer1a08acc2013-04-12 17:25:07 +00003241 // Transform (A & ~B) == 0 --> (A & B) != 0
3242 // and (A & ~B) != 0 --> (A & B) == 0
3243 // if A is a power of 2.
3244 if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
Hal Finkel60db0582014-09-07 18:57:58 +00003245 match(Op1, m_Zero()) && isKnownToBeAPowerOfTwo(A, false,
3246 0, AT, &I, DT) &&
3247 I.isEquality())
David Majnemer1a08acc2013-04-12 17:25:07 +00003248 return new ICmpInst(I.getInversePredicate(),
3249 Builder->CreateAnd(A, B),
3250 Op1);
3251
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00003252 // ~x < ~y --> y < x
3253 // ~x < cst --> ~cst < x
3254 if (match(Op0, m_Not(m_Value(A)))) {
3255 if (match(Op1, m_Not(m_Value(B))))
3256 return new ICmpInst(I.getPredicate(), B, A);
Chris Lattner497459d2011-01-15 05:42:47 +00003257 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
Chris Lattnerf3c4eef2011-01-15 05:41:33 +00003258 return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A);
3259 }
Chris Lattner5e0c0c72010-12-19 19:37:52 +00003260
3261 // (a+b) <u a --> llvm.uadd.with.overflow.
3262 // (a+b) <u b --> llvm.uadd.with.overflow.
3263 if (I.getPredicate() == ICmpInst::ICMP_ULT &&
Jim Grosbach129c52a2011-09-30 18:09:53 +00003264 match(Op0, m_Add(m_Value(A), m_Value(B))) &&
Chris Lattner5e0c0c72010-12-19 19:37:52 +00003265 (Op1 == A || Op1 == B))
3266 if (Instruction *R = ProcessUAddIdiom(I, Op0, *this))
3267 return R;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003268
Chris Lattner5e0c0c72010-12-19 19:37:52 +00003269 // a >u (a+b) --> llvm.uadd.with.overflow.
3270 // b >u (a+b) --> llvm.uadd.with.overflow.
3271 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
3272 match(Op1, m_Add(m_Value(A), m_Value(B))) &&
3273 (Op0 == A || Op0 == B))
3274 if (Instruction *R = ProcessUAddIdiom(I, Op1, *this))
3275 return R;
Serge Pavlov4bb54d52014-04-13 18:23:41 +00003276
3277 // (zext a) * (zext b) --> llvm.umul.with.overflow.
3278 if (match(Op0, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
3279 if (Instruction *R = ProcessUMulZExtIdiom(I, Op0, Op1, *this))
3280 return R;
3281 }
3282 if (match(Op1, m_Mul(m_ZExt(m_Value(A)), m_ZExt(m_Value(B))))) {
3283 if (Instruction *R = ProcessUMulZExtIdiom(I, Op1, Op0, *this))
3284 return R;
3285 }
Chris Lattner2188e402010-01-04 07:37:31 +00003286 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003287
Chris Lattner2188e402010-01-04 07:37:31 +00003288 if (I.isEquality()) {
3289 Value *A, *B, *C, *D;
Duncan Sands84653b32011-02-18 16:25:37 +00003290
Chris Lattner2188e402010-01-04 07:37:31 +00003291 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
3292 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0
3293 Value *OtherVal = A == Op1 ? B : A;
3294 return new ICmpInst(I.getPredicate(), OtherVal,
3295 Constant::getNullValue(A->getType()));
3296 }
3297
3298 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
3299 // A^c1 == C^c2 --> A == C^(c1^c2)
3300 ConstantInt *C1, *C2;
3301 if (match(B, m_ConstantInt(C1)) &&
3302 match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) {
Jakub Staszakbddea112013-06-06 20:18:46 +00003303 Constant *NC = Builder->getInt(C1->getValue() ^ C2->getValue());
Benjamin Kramer547b6c52011-09-27 20:39:19 +00003304 Value *Xor = Builder->CreateXor(C, NC);
Chris Lattner2188e402010-01-04 07:37:31 +00003305 return new ICmpInst(I.getPredicate(), A, Xor);
3306 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003307
Chris Lattner2188e402010-01-04 07:37:31 +00003308 // A^B == A^D -> B == D
3309 if (A == C) return new ICmpInst(I.getPredicate(), B, D);
3310 if (A == D) return new ICmpInst(I.getPredicate(), B, C);
3311 if (B == C) return new ICmpInst(I.getPredicate(), A, D);
3312 if (B == D) return new ICmpInst(I.getPredicate(), A, C);
3313 }
3314 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003315
Chris Lattner2188e402010-01-04 07:37:31 +00003316 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
3317 (A == Op0 || B == Op0)) {
3318 // A == (A^B) -> B == 0
3319 Value *OtherVal = A == Op0 ? B : A;
3320 return new ICmpInst(I.getPredicate(), OtherVal,
3321 Constant::getNullValue(A->getType()));
3322 }
3323
Chris Lattner2188e402010-01-04 07:37:31 +00003324 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
Jim Grosbach129c52a2011-09-30 18:09:53 +00003325 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
Chris Lattner31b106d2011-04-26 20:02:45 +00003326 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
Craig Topperf40110f2014-04-25 05:29:35 +00003327 Value *X = nullptr, *Y = nullptr, *Z = nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003328
Chris Lattner2188e402010-01-04 07:37:31 +00003329 if (A == C) {
3330 X = B; Y = D; Z = A;
3331 } else if (A == D) {
3332 X = B; Y = C; Z = A;
3333 } else if (B == C) {
3334 X = A; Y = D; Z = B;
3335 } else if (B == D) {
3336 X = A; Y = C; Z = B;
3337 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003338
Chris Lattner2188e402010-01-04 07:37:31 +00003339 if (X) { // Build (X^Y) & Z
Benjamin Kramer547b6c52011-09-27 20:39:19 +00003340 Op1 = Builder->CreateXor(X, Y);
3341 Op1 = Builder->CreateAnd(Op1, Z);
Chris Lattner2188e402010-01-04 07:37:31 +00003342 I.setOperand(0, Op1);
3343 I.setOperand(1, Constant::getNullValue(Op1->getType()));
3344 return &I;
3345 }
3346 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003347
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00003348 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
Benjamin Kramer21501452012-06-11 08:01:25 +00003349 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B)
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00003350 ConstantInt *Cst1;
Benjamin Kramer21501452012-06-11 08:01:25 +00003351 if ((Op0->hasOneUse() &&
3352 match(Op0, m_ZExt(m_Value(A))) &&
3353 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
3354 (Op1->hasOneUse() &&
3355 match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
3356 match(Op1, m_ZExt(m_Value(A))))) {
Benjamin Kramer8b8a7692012-06-10 20:35:00 +00003357 APInt Pow2 = Cst1->getValue() + 1;
3358 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
3359 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
3360 return new ICmpInst(I.getPredicate(), A,
3361 Builder->CreateTrunc(B, A->getType()));
3362 }
3363
Benjamin Kramer03f3e242013-11-16 16:00:48 +00003364 // (A >> C) == (B >> C) --> (A^B) u< (1 << C)
3365 // For lshr and ashr pairs.
3366 if ((match(Op0, m_OneUse(m_LShr(m_Value(A), m_ConstantInt(Cst1)))) &&
3367 match(Op1, m_OneUse(m_LShr(m_Value(B), m_Specific(Cst1))))) ||
3368 (match(Op0, m_OneUse(m_AShr(m_Value(A), m_ConstantInt(Cst1)))) &&
3369 match(Op1, m_OneUse(m_AShr(m_Value(B), m_Specific(Cst1)))))) {
3370 unsigned TypeBits = Cst1->getBitWidth();
3371 unsigned ShAmt = (unsigned)Cst1->getLimitedValue(TypeBits);
3372 if (ShAmt < TypeBits && ShAmt != 0) {
3373 ICmpInst::Predicate Pred = I.getPredicate() == ICmpInst::ICMP_NE
3374 ? ICmpInst::ICMP_UGE
3375 : ICmpInst::ICMP_ULT;
3376 Value *Xor = Builder->CreateXor(A, B, I.getName() + ".unshifted");
3377 APInt CmpVal = APInt::getOneBitSet(TypeBits, ShAmt);
3378 return new ICmpInst(Pred, Xor, Builder->getInt(CmpVal));
3379 }
3380 }
3381
Chris Lattner1b06c712011-04-26 20:18:20 +00003382 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
3383 // "icmp (and X, mask), cst"
3384 uint64_t ShAmt = 0;
Chris Lattner1b06c712011-04-26 20:18:20 +00003385 if (Op0->hasOneUse() &&
3386 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A),
3387 m_ConstantInt(ShAmt))))) &&
3388 match(Op1, m_ConstantInt(Cst1)) &&
3389 // Only do this when A has multiple uses. This is most important to do
3390 // when it exposes other optimizations.
3391 !A->hasOneUse()) {
3392 unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003393
Chris Lattner1b06c712011-04-26 20:18:20 +00003394 if (ShAmt < ASize) {
3395 APInt MaskV =
3396 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
3397 MaskV <<= ShAmt;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003398
Chris Lattner1b06c712011-04-26 20:18:20 +00003399 APInt CmpV = Cst1->getValue().zext(ASize);
3400 CmpV <<= ShAmt;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003401
Chris Lattner1b06c712011-04-26 20:18:20 +00003402 Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV));
3403 return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV));
3404 }
3405 }
Chris Lattner2188e402010-01-04 07:37:31 +00003406 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003407
Chris Lattner2188e402010-01-04 07:37:31 +00003408 {
3409 Value *X; ConstantInt *Cst;
3410 // icmp X+Cst, X
3411 if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X)
Benjamin Kramer0e2d1622013-09-20 22:12:42 +00003412 return FoldICmpAddOpCst(I, X, Cst, I.getPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00003413
3414 // icmp X, X+Cst
3415 if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X)
Benjamin Kramer0e2d1622013-09-20 22:12:42 +00003416 return FoldICmpAddOpCst(I, X, Cst, I.getSwappedPredicate());
Chris Lattner2188e402010-01-04 07:37:31 +00003417 }
Craig Topperf40110f2014-04-25 05:29:35 +00003418 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003419}
3420
Chris Lattner2188e402010-01-04 07:37:31 +00003421/// FoldFCmp_IntToFP_Cst - Fold fcmp ([us]itofp x, cst) if possible.
3422///
3423Instruction *InstCombiner::FoldFCmp_IntToFP_Cst(FCmpInst &I,
3424 Instruction *LHSI,
3425 Constant *RHSC) {
Craig Topperf40110f2014-04-25 05:29:35 +00003426 if (!isa<ConstantFP>(RHSC)) return nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003427 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003428
Chris Lattner2188e402010-01-04 07:37:31 +00003429 // Get the width of the mantissa. We don't want to hack on conversions that
3430 // might lose information from the integer, e.g. "i64 -> float"
3431 int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
Craig Topperf40110f2014-04-25 05:29:35 +00003432 if (MantissaWidth == -1) return nullptr; // Unknown.
Jim Grosbach129c52a2011-09-30 18:09:53 +00003433
Chris Lattner2188e402010-01-04 07:37:31 +00003434 // Check to see that the input is converted from an integer type that is small
3435 // enough that preserves all bits. TODO: check here for "known" sign bits.
3436 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
3437 unsigned InputSize = LHSI->getOperand(0)->getType()->getScalarSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003438
Chris Lattner2188e402010-01-04 07:37:31 +00003439 // If this is a uitofp instruction, we need an extra bit to hold the sign.
3440 bool LHSUnsigned = isa<UIToFPInst>(LHSI);
3441 if (LHSUnsigned)
3442 ++InputSize;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003443
Chris Lattner2188e402010-01-04 07:37:31 +00003444 // If the conversion would lose info, don't hack on this.
3445 if ((int)InputSize > MantissaWidth)
Craig Topperf40110f2014-04-25 05:29:35 +00003446 return nullptr;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003447
Chris Lattner2188e402010-01-04 07:37:31 +00003448 // Otherwise, we can potentially simplify the comparison. We know that it
3449 // will always come through as an integer value and we know the constant is
3450 // not a NAN (it would have been previously simplified).
3451 assert(!RHS.isNaN() && "NaN comparison not already folded!");
Jim Grosbach129c52a2011-09-30 18:09:53 +00003452
Chris Lattner2188e402010-01-04 07:37:31 +00003453 ICmpInst::Predicate Pred;
3454 switch (I.getPredicate()) {
3455 default: llvm_unreachable("Unexpected predicate!");
3456 case FCmpInst::FCMP_UEQ:
3457 case FCmpInst::FCMP_OEQ:
3458 Pred = ICmpInst::ICMP_EQ;
3459 break;
3460 case FCmpInst::FCMP_UGT:
3461 case FCmpInst::FCMP_OGT:
3462 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
3463 break;
3464 case FCmpInst::FCMP_UGE:
3465 case FCmpInst::FCMP_OGE:
3466 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
3467 break;
3468 case FCmpInst::FCMP_ULT:
3469 case FCmpInst::FCMP_OLT:
3470 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
3471 break;
3472 case FCmpInst::FCMP_ULE:
3473 case FCmpInst::FCMP_OLE:
3474 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
3475 break;
3476 case FCmpInst::FCMP_UNE:
3477 case FCmpInst::FCMP_ONE:
3478 Pred = ICmpInst::ICMP_NE;
3479 break;
3480 case FCmpInst::FCMP_ORD:
Jakub Staszakbddea112013-06-06 20:18:46 +00003481 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003482 case FCmpInst::FCMP_UNO:
Jakub Staszakbddea112013-06-06 20:18:46 +00003483 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003484 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003485
Chris Lattner229907c2011-07-18 04:54:35 +00003486 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
Jim Grosbach129c52a2011-09-30 18:09:53 +00003487
Chris Lattner2188e402010-01-04 07:37:31 +00003488 // Now we know that the APFloat is a normal number, zero or inf.
Jim Grosbach129c52a2011-09-30 18:09:53 +00003489
Chris Lattner2188e402010-01-04 07:37:31 +00003490 // See if the FP constant is too large for the integer. For example,
3491 // comparing an i8 to 300.0.
3492 unsigned IntWidth = IntTy->getScalarSizeInBits();
Jim Grosbach129c52a2011-09-30 18:09:53 +00003493
Chris Lattner2188e402010-01-04 07:37:31 +00003494 if (!LHSUnsigned) {
3495 // If the RHS value is > SignedMax, fold the comparison. This handles +INF
3496 // and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00003497 APFloat SMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00003498 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
3499 APFloat::rmNearestTiesToEven);
3500 if (SMax.compare(RHS) == APFloat::cmpLessThan) { // smax < 13123.0
3501 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT ||
3502 Pred == ICmpInst::ICMP_SLE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003503 return ReplaceInstUsesWith(I, Builder->getTrue());
3504 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003505 }
3506 } else {
3507 // If the RHS value is > UnsignedMax, fold the comparison. This handles
3508 // +INF and large values.
Michael Gottesman79b09672013-06-27 21:58:19 +00003509 APFloat UMax(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00003510 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
3511 APFloat::rmNearestTiesToEven);
3512 if (UMax.compare(RHS) == APFloat::cmpLessThan) { // umax < 13123.0
3513 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT ||
3514 Pred == ICmpInst::ICMP_ULE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003515 return ReplaceInstUsesWith(I, Builder->getTrue());
3516 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003517 }
3518 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003519
Chris Lattner2188e402010-01-04 07:37:31 +00003520 if (!LHSUnsigned) {
3521 // See if the RHS value is < SignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00003522 APFloat SMin(RHS.getSemantics());
Chris Lattner2188e402010-01-04 07:37:31 +00003523 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
3524 APFloat::rmNearestTiesToEven);
3525 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
3526 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
3527 Pred == ICmpInst::ICMP_SGE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003528 return ReplaceInstUsesWith(I, Builder->getTrue());
3529 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003530 }
Devang Patel698452b2012-02-13 23:05:18 +00003531 } else {
3532 // See if the RHS value is < UnsignedMin.
Michael Gottesman79b09672013-06-27 21:58:19 +00003533 APFloat SMin(RHS.getSemantics());
Devang Patel698452b2012-02-13 23:05:18 +00003534 SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
3535 APFloat::rmNearestTiesToEven);
3536 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
3537 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
3538 Pred == ICmpInst::ICMP_UGE)
Jakub Staszakbddea112013-06-06 20:18:46 +00003539 return ReplaceInstUsesWith(I, Builder->getTrue());
3540 return ReplaceInstUsesWith(I, Builder->getFalse());
Devang Patel698452b2012-02-13 23:05:18 +00003541 }
Chris Lattner2188e402010-01-04 07:37:31 +00003542 }
3543
3544 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
3545 // [0, UMAX], but it may still be fractional. See if it is fractional by
3546 // casting the FP value to the integer value and back, checking for equality.
3547 // Don't do this for zero, because -0.0 is not fractional.
3548 Constant *RHSInt = LHSUnsigned
3549 ? ConstantExpr::getFPToUI(RHSC, IntTy)
3550 : ConstantExpr::getFPToSI(RHSC, IntTy);
3551 if (!RHS.isZero()) {
3552 bool Equal = LHSUnsigned
3553 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
3554 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
3555 if (!Equal) {
3556 // If we had a comparison against a fractional value, we have to adjust
3557 // the compare predicate and sometimes the value. RHSC is rounded towards
3558 // zero at this point.
3559 switch (Pred) {
3560 default: llvm_unreachable("Unexpected integer comparison!");
3561 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true
Jakub Staszakbddea112013-06-06 20:18:46 +00003562 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003563 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false
Jakub Staszakbddea112013-06-06 20:18:46 +00003564 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003565 case ICmpInst::ICMP_ULE:
3566 // (float)int <= 4.4 --> int <= 4
3567 // (float)int <= -4.4 --> false
3568 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003569 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003570 break;
3571 case ICmpInst::ICMP_SLE:
3572 // (float)int <= 4.4 --> int <= 4
3573 // (float)int <= -4.4 --> int < -4
3574 if (RHS.isNegative())
3575 Pred = ICmpInst::ICMP_SLT;
3576 break;
3577 case ICmpInst::ICMP_ULT:
3578 // (float)int < -4.4 --> false
3579 // (float)int < 4.4 --> int <= 4
3580 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003581 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner2188e402010-01-04 07:37:31 +00003582 Pred = ICmpInst::ICMP_ULE;
3583 break;
3584 case ICmpInst::ICMP_SLT:
3585 // (float)int < -4.4 --> int < -4
3586 // (float)int < 4.4 --> int <= 4
3587 if (!RHS.isNegative())
3588 Pred = ICmpInst::ICMP_SLE;
3589 break;
3590 case ICmpInst::ICMP_UGT:
3591 // (float)int > 4.4 --> int > 4
3592 // (float)int > -4.4 --> true
3593 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003594 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003595 break;
3596 case ICmpInst::ICMP_SGT:
3597 // (float)int > 4.4 --> int > 4
3598 // (float)int > -4.4 --> int >= -4
3599 if (RHS.isNegative())
3600 Pred = ICmpInst::ICMP_SGE;
3601 break;
3602 case ICmpInst::ICMP_UGE:
3603 // (float)int >= -4.4 --> true
3604 // (float)int >= 4.4 --> int > 4
Bob Wilson61f3ad52012-08-07 22:35:16 +00003605 if (RHS.isNegative())
Jakub Staszakbddea112013-06-06 20:18:46 +00003606 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner2188e402010-01-04 07:37:31 +00003607 Pred = ICmpInst::ICMP_UGT;
3608 break;
3609 case ICmpInst::ICMP_SGE:
3610 // (float)int >= -4.4 --> int >= -4
3611 // (float)int >= 4.4 --> int > 4
3612 if (!RHS.isNegative())
3613 Pred = ICmpInst::ICMP_SGT;
3614 break;
3615 }
3616 }
3617 }
3618
3619 // Lower this FP comparison into an appropriate integer version of the
3620 // comparison.
3621 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
3622}
3623
3624Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
3625 bool Changed = false;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003626
Chris Lattner2188e402010-01-04 07:37:31 +00003627 /// Orders the operands of the compare so that they are listed from most
3628 /// complex to least complex. This puts constants before unary operators,
3629 /// before binary operators.
3630 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
3631 I.swapOperands();
3632 Changed = true;
3633 }
3634
3635 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Jim Grosbach129c52a2011-09-30 18:09:53 +00003636
Hal Finkel60db0582014-09-07 18:57:58 +00003637 if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1, DL, TLI, DT, AT))
Chris Lattner2188e402010-01-04 07:37:31 +00003638 return ReplaceInstUsesWith(I, V);
3639
3640 // Simplify 'fcmp pred X, X'
3641 if (Op0 == Op1) {
3642 switch (I.getPredicate()) {
3643 default: llvm_unreachable("Unknown predicate!");
3644 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y)
3645 case FCmpInst::FCMP_ULT: // True if unordered or less than
3646 case FCmpInst::FCMP_UGT: // True if unordered or greater than
3647 case FCmpInst::FCMP_UNE: // True if unordered or not equal
3648 // Canonicalize these to be 'fcmp uno %X, 0.0'.
3649 I.setPredicate(FCmpInst::FCMP_UNO);
3650 I.setOperand(1, Constant::getNullValue(Op0->getType()));
3651 return &I;
Jim Grosbach129c52a2011-09-30 18:09:53 +00003652
Chris Lattner2188e402010-01-04 07:37:31 +00003653 case FCmpInst::FCMP_ORD: // True if ordered (no nans)
3654 case FCmpInst::FCMP_OEQ: // True if ordered and equal
3655 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal
3656 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal
3657 // Canonicalize these to be 'fcmp ord %X, 0.0'.
3658 I.setPredicate(FCmpInst::FCMP_ORD);
3659 I.setOperand(1, Constant::getNullValue(Op0->getType()));
3660 return &I;
3661 }
3662 }
Jim Grosbach129c52a2011-09-30 18:09:53 +00003663
Chris Lattner2188e402010-01-04 07:37:31 +00003664 // Handle fcmp with constant RHS
3665 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
3666 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3667 switch (LHSI->getOpcode()) {
Benjamin Kramercbb18e92011-03-31 10:12:07 +00003668 case Instruction::FPExt: {
3669 // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
3670 FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
3671 ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
3672 if (!RHSF)
3673 break;
3674
3675 const fltSemantics *Sem;
3676 // FIXME: This shouldn't be here.
Dan Gohman518cda42011-12-17 00:04:22 +00003677 if (LHSExt->getSrcTy()->isHalfTy())
3678 Sem = &APFloat::IEEEhalf;
3679 else if (LHSExt->getSrcTy()->isFloatTy())
Benjamin Kramercbb18e92011-03-31 10:12:07 +00003680 Sem = &APFloat::IEEEsingle;
3681 else if (LHSExt->getSrcTy()->isDoubleTy())
3682 Sem = &APFloat::IEEEdouble;
3683 else if (LHSExt->getSrcTy()->isFP128Ty())
3684 Sem = &APFloat::IEEEquad;
3685 else if (LHSExt->getSrcTy()->isX86_FP80Ty())
3686 Sem = &APFloat::x87DoubleExtended;
Ulrich Weigand6a9bb512012-10-30 12:33:18 +00003687 else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
3688 Sem = &APFloat::PPCDoubleDouble;
Benjamin Kramercbb18e92011-03-31 10:12:07 +00003689 else
3690 break;
3691
3692 bool Lossy;
3693 APFloat F = RHSF->getValueAPF();
3694 F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
3695
Jim Grosbach24ff8342011-09-30 18:45:50 +00003696 // Avoid lossy conversions and denormals. Zero is a special case
3697 // that's OK to convert.
Jim Grosbach011dafb2011-09-30 19:58:46 +00003698 APFloat Fabs = F;
3699 Fabs.clearSign();
Benjamin Kramercbb18e92011-03-31 10:12:07 +00003700 if (!Lossy &&
Jim Grosbach011dafb2011-09-30 19:58:46 +00003701 ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
3702 APFloat::cmpLessThan) || Fabs.isZero()))
Jim Grosbach24ff8342011-09-30 18:45:50 +00003703
Benjamin Kramercbb18e92011-03-31 10:12:07 +00003704 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3705 ConstantFP::get(RHSC->getContext(), F));
3706 break;
3707 }
Chris Lattner2188e402010-01-04 07:37:31 +00003708 case Instruction::PHI:
3709 // Only fold fcmp into the PHI if the phi and fcmp are in the same
3710 // block. If in the same block, we're encouraging jump threading. If
3711 // not, we are just pessimizing the code by making an i1 phi.
3712 if (LHSI->getParent() == I.getParent())
Chris Lattnerea7131a2011-01-16 05:14:26 +00003713 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner2188e402010-01-04 07:37:31 +00003714 return NV;
3715 break;
3716 case Instruction::SIToFP:
3717 case Instruction::UIToFP:
3718 if (Instruction *NV = FoldFCmp_IntToFP_Cst(I, LHSI, RHSC))
3719 return NV;
3720 break;
Benjamin Kramera8c5d082011-03-31 10:12:15 +00003721 case Instruction::FSub: {
3722 // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
3723 Value *Op;
3724 if (match(LHSI, m_FNeg(m_Value(Op))))
3725 return new FCmpInst(I.getSwappedPredicate(), Op,
3726 ConstantExpr::getFNeg(RHSC));
3727 break;
3728 }
Dan Gohman94732022010-02-24 06:46:09 +00003729 case Instruction::Load:
3730 if (GetElementPtrInst *GEP =
3731 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3732 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3733 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3734 !cast<LoadInst>(LHSI)->isVolatile())
3735 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
3736 return Res;
3737 }
3738 break;
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00003739 case Instruction::Call: {
3740 CallInst *CI = cast<CallInst>(LHSI);
3741 LibFunc::Func Func;
3742 // Various optimization for fabs compared with zero.
Benjamin Kramer9d032422012-08-18 22:04:34 +00003743 if (RHSC->isNullValue() && CI->getCalledFunction() &&
Benjamin Kramer8c2a7332012-08-18 20:06:47 +00003744 TLI->getLibFunc(CI->getCalledFunction()->getName(), Func) &&
3745 TLI->has(Func)) {
3746 if (Func == LibFunc::fabs || Func == LibFunc::fabsf ||
3747 Func == LibFunc::fabsl) {
3748 switch (I.getPredicate()) {
3749 default: break;
3750 // fabs(x) < 0 --> false
3751 case FCmpInst::FCMP_OLT:
3752 return ReplaceInstUsesWith(I, Builder->getFalse());
3753 // fabs(x) > 0 --> x != 0
3754 case FCmpInst::FCMP_OGT:
3755 return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0),
3756 RHSC);
3757 // fabs(x) <= 0 --> x == 0
3758 case FCmpInst::FCMP_OLE:
3759 return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0),
3760 RHSC);
3761 // fabs(x) >= 0 --> !isnan(x)
3762 case FCmpInst::FCMP_OGE:
3763 return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0),
3764 RHSC);
3765 // fabs(x) == 0 --> x == 0
3766 // fabs(x) != 0 --> x != 0
3767 case FCmpInst::FCMP_OEQ:
3768 case FCmpInst::FCMP_UEQ:
3769 case FCmpInst::FCMP_ONE:
3770 case FCmpInst::FCMP_UNE:
3771 return new FCmpInst(I.getPredicate(), CI->getArgOperand(0),
3772 RHSC);
3773 }
3774 }
3775 }
3776 }
Chris Lattner2188e402010-01-04 07:37:31 +00003777 }
Chris Lattner2188e402010-01-04 07:37:31 +00003778 }
3779
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00003780 // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
Benjamin Kramerd159d942011-03-31 10:12:22 +00003781 Value *X, *Y;
3782 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
Benjamin Kramerbe209ab2011-03-31 10:46:03 +00003783 return new FCmpInst(I.getSwappedPredicate(), X, Y);
Benjamin Kramerd159d942011-03-31 10:12:22 +00003784
Benjamin Kramer2ccfbc82011-03-31 10:11:58 +00003785 // fcmp (fpext x), (fpext y) -> fcmp x, y
3786 if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
3787 if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
3788 if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
3789 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3790 RHSExt->getOperand(0));
3791
Craig Topperf40110f2014-04-25 05:29:35 +00003792 return Changed ? &I : nullptr;
Chris Lattner2188e402010-01-04 07:37:31 +00003793}