blob: fd2b68a9ecdb8aeb0dee5ea2edcb02ce9f594282 [file] [log] [blame]
Chris Lattner02446fc2010-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 Friedman74703252011-07-20 21:57:23 +000015#include "llvm/Analysis/ConstantFolding.h"
Chris Lattner02446fc2010-01-04 07:37:31 +000016#include "llvm/Analysis/InstructionSimplify.h"
17#include "llvm/Analysis/MemoryBuiltins.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000018#include "llvm/IR/DataLayout.h"
19#include "llvm/IR/IntrinsicInst.h"
Chris Lattner02446fc2010-01-04 07:37:31 +000020#include "llvm/Support/ConstantRange.h"
21#include "llvm/Support/GetElementPtrTypeIterator.h"
22#include "llvm/Support/PatternMatch.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000023#include "llvm/Target/TargetLibraryInfo.h"
Chris Lattner02446fc2010-01-04 07:37:31 +000024using namespace llvm;
25using namespace PatternMatch;
26
Chris Lattnerb20c0b52011-02-10 05:23:05 +000027static ConstantInt *getOne(Constant *C) {
28 return ConstantInt::get(cast<IntegerType>(C->getType()), 1);
29}
30
Chris Lattner02446fc2010-01-04 07:37:31 +000031/// AddOne - Add one to a ConstantInt
32static Constant *AddOne(Constant *C) {
33 return ConstantExpr::getAdd(C, ConstantInt::get(C->getType(), 1));
34}
35/// SubOne - Subtract one from a ConstantInt
Chris Lattnerb20c0b52011-02-10 05:23:05 +000036static Constant *SubOne(Constant *C) {
37 return ConstantExpr::getSub(C, ConstantInt::get(C->getType(), 1));
Chris Lattner02446fc2010-01-04 07:37:31 +000038}
39
40static ConstantInt *ExtractElement(Constant *V, Constant *Idx) {
41 return cast<ConstantInt>(ConstantExpr::getExtractElement(V, Idx));
42}
43
44static bool HasAddOverflow(ConstantInt *Result,
45 ConstantInt *In1, ConstantInt *In2,
46 bool IsSigned) {
Chris Lattnerc73b24d2011-07-15 06:08:15 +000047 if (!IsSigned)
Chris Lattner02446fc2010-01-04 07:37:31 +000048 return Result->getValue().ult(In1->getValue());
Chris Lattnerc73b24d2011-07-15 06:08:15 +000049
50 if (In2->isNegative())
51 return Result->getValue().sgt(In1->getValue());
52 return Result->getValue().slt(In1->getValue());
Chris Lattner02446fc2010-01-04 07:37:31 +000053}
54
55/// AddWithOverflow - Compute Result = In1+In2, returning true if the result
56/// overflowed for this type.
57static bool AddWithOverflow(Constant *&Result, Constant *In1,
58 Constant *In2, bool IsSigned = false) {
59 Result = ConstantExpr::getAdd(In1, In2);
60
Chris Lattnerdb125cf2011-07-18 04:54:35 +000061 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
Chris Lattner02446fc2010-01-04 07:37:31 +000062 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
63 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
64 if (HasAddOverflow(ExtractElement(Result, Idx),
65 ExtractElement(In1, Idx),
66 ExtractElement(In2, Idx),
67 IsSigned))
68 return true;
69 }
70 return false;
71 }
72
73 return HasAddOverflow(cast<ConstantInt>(Result),
74 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
75 IsSigned);
76}
77
78static bool HasSubOverflow(ConstantInt *Result,
79 ConstantInt *In1, ConstantInt *In2,
80 bool IsSigned) {
Chris Lattnerc73b24d2011-07-15 06:08:15 +000081 if (!IsSigned)
Chris Lattner02446fc2010-01-04 07:37:31 +000082 return Result->getValue().ugt(In1->getValue());
Jim Grosbach0cc4a952011-09-30 18:09:53 +000083
Chris Lattnerc73b24d2011-07-15 06:08:15 +000084 if (In2->isNegative())
85 return Result->getValue().slt(In1->getValue());
86
87 return Result->getValue().sgt(In1->getValue());
Chris Lattner02446fc2010-01-04 07:37:31 +000088}
89
90/// SubWithOverflow - Compute Result = In1-In2, returning true if the result
91/// overflowed for this type.
92static bool SubWithOverflow(Constant *&Result, Constant *In1,
93 Constant *In2, bool IsSigned = false) {
94 Result = ConstantExpr::getSub(In1, In2);
95
Chris Lattnerdb125cf2011-07-18 04:54:35 +000096 if (VectorType *VTy = dyn_cast<VectorType>(In1->getType())) {
Chris Lattner02446fc2010-01-04 07:37:31 +000097 for (unsigned i = 0, e = VTy->getNumElements(); i != e; ++i) {
98 Constant *Idx = ConstantInt::get(Type::getInt32Ty(In1->getContext()), i);
99 if (HasSubOverflow(ExtractElement(Result, Idx),
100 ExtractElement(In1, Idx),
101 ExtractElement(In2, Idx),
102 IsSigned))
103 return true;
104 }
105 return false;
106 }
107
108 return HasSubOverflow(cast<ConstantInt>(Result),
109 cast<ConstantInt>(In1), cast<ConstantInt>(In2),
110 IsSigned);
111}
112
113/// isSignBitCheck - Given an exploded icmp instruction, return true if the
114/// comparison only checks the sign bit. If it only checks the sign bit, set
115/// TrueIfSigned if the result of the comparison is true when the input value is
116/// signed.
117static bool isSignBitCheck(ICmpInst::Predicate pred, ConstantInt *RHS,
118 bool &TrueIfSigned) {
119 switch (pred) {
120 case ICmpInst::ICMP_SLT: // True if LHS s< 0
121 TrueIfSigned = true;
122 return RHS->isZero();
123 case ICmpInst::ICMP_SLE: // True if LHS s<= RHS and RHS == -1
124 TrueIfSigned = true;
125 return RHS->isAllOnesValue();
126 case ICmpInst::ICMP_SGT: // True if LHS s> -1
127 TrueIfSigned = false;
128 return RHS->isAllOnesValue();
129 case ICmpInst::ICMP_UGT:
130 // True if LHS u> RHS and RHS == high-bit-mask - 1
131 TrueIfSigned = true;
Chris Lattnerc73b24d2011-07-15 06:08:15 +0000132 return RHS->isMaxValue(true);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000133 case ICmpInst::ICMP_UGE:
Chris Lattner02446fc2010-01-04 07:37:31 +0000134 // True if LHS u>= RHS and RHS == high-bit-mask (2^7, 2^15, 2^31, etc)
135 TrueIfSigned = true;
136 return RHS->getValue().isSignBit();
137 default:
138 return false;
139 }
140}
141
Arnaud A. de Grandmaison1bb93a92013-03-25 11:47:38 +0000142/// Returns true if the exploded icmp can be expressed as a signed comparison
143/// to zero and updates the predicate accordingly.
144/// The signedness of the comparison is preserved.
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +0000145static bool isSignTest(ICmpInst::Predicate &pred, const ConstantInt *RHS) {
146 if (!ICmpInst::isSigned(pred))
147 return false;
148
149 if (RHS->isZero())
Arnaud A. de Grandmaison1bb93a92013-03-25 11:47:38 +0000150 return ICmpInst::isRelational(pred);
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +0000151
Arnaud A. de Grandmaison1bb93a92013-03-25 11:47:38 +0000152 if (RHS->isOne()) {
153 if (pred == ICmpInst::ICMP_SLT) {
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +0000154 pred = ICmpInst::ICMP_SLE;
155 return true;
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +0000156 }
Arnaud A. de Grandmaison1bb93a92013-03-25 11:47:38 +0000157 } else if (RHS->isAllOnesValue()) {
158 if (pred == ICmpInst::ICMP_SGT) {
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +0000159 pred = ICmpInst::ICMP_SGE;
160 return true;
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +0000161 }
Arnaud A. de Grandmaison1bb93a92013-03-25 11:47:38 +0000162 }
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +0000163
164 return false;
165}
166
Chris Lattner02446fc2010-01-04 07:37:31 +0000167// isHighOnes - Return true if the constant is of the form 1+0+.
168// This is the same as lowones(~X).
169static bool isHighOnes(const ConstantInt *CI) {
170 return (~CI->getValue() + 1).isPowerOf2();
171}
172
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000173/// ComputeSignedMinMaxValuesFromKnownBits - Given a signed integer type and a
Chris Lattner02446fc2010-01-04 07:37:31 +0000174/// set of known zero and one bits, compute the maximum and minimum values that
175/// could have the specified known zero and known one bits, returning them in
176/// min/max.
177static void ComputeSignedMinMaxValuesFromKnownBits(const APInt& KnownZero,
178 const APInt& KnownOne,
179 APInt& Min, APInt& Max) {
180 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
181 KnownZero.getBitWidth() == Min.getBitWidth() &&
182 KnownZero.getBitWidth() == Max.getBitWidth() &&
183 "KnownZero, KnownOne and Min, Max must have equal bitwidth.");
184 APInt UnknownBits = ~(KnownZero|KnownOne);
185
186 // The minimum value is when all unknown bits are zeros, EXCEPT for the sign
187 // bit if it is unknown.
188 Min = KnownOne;
189 Max = KnownOne|UnknownBits;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000190
Chris Lattner02446fc2010-01-04 07:37:31 +0000191 if (UnknownBits.isNegative()) { // Sign bit is unknown
Jay Foad7a874dd2010-12-01 08:53:58 +0000192 Min.setBit(Min.getBitWidth()-1);
193 Max.clearBit(Max.getBitWidth()-1);
Chris Lattner02446fc2010-01-04 07:37:31 +0000194 }
195}
196
197// ComputeUnsignedMinMaxValuesFromKnownBits - Given an unsigned integer type and
198// a set of known zero and one bits, compute the maximum and minimum values that
199// could have the specified known zero and known one bits, returning them in
200// min/max.
201static void ComputeUnsignedMinMaxValuesFromKnownBits(const APInt &KnownZero,
202 const APInt &KnownOne,
203 APInt &Min, APInt &Max) {
204 assert(KnownZero.getBitWidth() == KnownOne.getBitWidth() &&
205 KnownZero.getBitWidth() == Min.getBitWidth() &&
206 KnownZero.getBitWidth() == Max.getBitWidth() &&
207 "Ty, KnownZero, KnownOne and Min, Max must have equal bitwidth.");
208 APInt UnknownBits = ~(KnownZero|KnownOne);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000209
Chris Lattner02446fc2010-01-04 07:37:31 +0000210 // The minimum value is when the unknown bits are all zeros.
211 Min = KnownOne;
212 // The maximum value is when the unknown bits are all ones.
213 Max = KnownOne|UnknownBits;
214}
215
216
217
218/// FoldCmpLoadFromIndexedGlobal - Called we see this pattern:
219/// cmp pred (load (gep GV, ...)), cmpcst
220/// where GV is a global variable with a constant initializer. Try to simplify
221/// this into some simple computation that does not need the load. For example
222/// we can optimize "icmp eq (load (gep "foo", 0, i)), 0" into "icmp eq i, 3".
223///
224/// If AndCst is non-null, then the loaded value is masked with that constant
225/// before doing the comparison. This handles cases like "A[i]&4 == 0".
226Instruction *InstCombiner::
227FoldCmpLoadFromIndexedGlobal(GetElementPtrInst *GEP, GlobalVariable *GV,
228 CmpInst &ICI, ConstantInt *AndCst) {
Chris Lattnerd7f5a582010-01-04 18:57:15 +0000229 // We need TD information to know the pointer size unless this is inbounds.
230 if (!GEP->isInBounds() && TD == 0) return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000231
Chris Lattnerc8d75c72012-01-31 02:55:06 +0000232 Constant *Init = GV->getInitializer();
233 if (!isa<ConstantArray>(Init) && !isa<ConstantDataArray>(Init))
234 return 0;
Jim Grosbach03fceff2013-04-05 21:20:12 +0000235
Chris Lattnerc8d75c72012-01-31 02:55:06 +0000236 uint64_t ArrayElementCount = Init->getType()->getArrayNumElements();
237 if (ArrayElementCount > 1024) return 0; // Don't blow up on huge arrays.
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000238
Chris Lattner02446fc2010-01-04 07:37:31 +0000239 // There are many forms of this optimization we can handle, for now, just do
240 // the simple index into a single-dimensional array.
241 //
242 // Require: GEP GV, 0, i {{, constant indices}}
243 if (GEP->getNumOperands() < 3 ||
244 !isa<ConstantInt>(GEP->getOperand(1)) ||
245 !cast<ConstantInt>(GEP->getOperand(1))->isZero() ||
246 isa<Constant>(GEP->getOperand(2)))
247 return 0;
248
249 // Check that indices after the variable are constants and in-range for the
250 // type they index. Collect the indices. This is typically for arrays of
251 // structs.
252 SmallVector<unsigned, 4> LaterIndices;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000253
Chris Lattnerc8d75c72012-01-31 02:55:06 +0000254 Type *EltTy = Init->getType()->getArrayElementType();
Chris Lattner02446fc2010-01-04 07:37:31 +0000255 for (unsigned i = 3, e = GEP->getNumOperands(); i != e; ++i) {
256 ConstantInt *Idx = dyn_cast<ConstantInt>(GEP->getOperand(i));
257 if (Idx == 0) return 0; // Variable index.
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000258
Chris Lattner02446fc2010-01-04 07:37:31 +0000259 uint64_t IdxVal = Idx->getZExtValue();
260 if ((unsigned)IdxVal != IdxVal) return 0; // Too large array index.
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000261
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000262 if (StructType *STy = dyn_cast<StructType>(EltTy))
Chris Lattner02446fc2010-01-04 07:37:31 +0000263 EltTy = STy->getElementType(IdxVal);
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000264 else if (ArrayType *ATy = dyn_cast<ArrayType>(EltTy)) {
Chris Lattner02446fc2010-01-04 07:37:31 +0000265 if (IdxVal >= ATy->getNumElements()) return 0;
266 EltTy = ATy->getElementType();
267 } else {
268 return 0; // Unknown type.
269 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000270
Chris Lattner02446fc2010-01-04 07:37:31 +0000271 LaterIndices.push_back(IdxVal);
272 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000273
Chris Lattner02446fc2010-01-04 07:37:31 +0000274 enum { Overdefined = -3, Undefined = -2 };
275
276 // Variables for our state machines.
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000277
Chris Lattner02446fc2010-01-04 07:37:31 +0000278 // FirstTrueElement/SecondTrueElement - Used to emit a comparison of the form
279 // "i == 47 | i == 87", where 47 is the first index the condition is true for,
280 // and 87 is the second (and last) index. FirstTrueElement is -2 when
281 // undefined, otherwise set to the first true element. SecondTrueElement is
282 // -2 when undefined, -3 when overdefined and >= 0 when that index is true.
283 int FirstTrueElement = Undefined, SecondTrueElement = Undefined;
284
285 // FirstFalseElement/SecondFalseElement - Used to emit a comparison of the
286 // form "i != 47 & i != 87". Same state transitions as for true elements.
287 int FirstFalseElement = Undefined, SecondFalseElement = Undefined;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000288
Chris Lattner02446fc2010-01-04 07:37:31 +0000289 /// TrueRangeEnd/FalseRangeEnd - In conjunction with First*Element, these
290 /// define a state machine that triggers for ranges of values that the index
291 /// is true or false for. This triggers on things like "abbbbc"[i] == 'b'.
292 /// This is -2 when undefined, -3 when overdefined, and otherwise the last
293 /// index in the range (inclusive). We use -2 for undefined here because we
294 /// use relative comparisons and don't want 0-1 to match -1.
295 int TrueRangeEnd = Undefined, FalseRangeEnd = Undefined;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000296
Chris Lattner02446fc2010-01-04 07:37:31 +0000297 // MagicBitvector - This is a magic bitvector where we set a bit if the
298 // comparison is true for element 'i'. If there are 64 elements or less in
299 // the array, this will fully represent all the comparison results.
300 uint64_t MagicBitvector = 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000301
302
Chris Lattner02446fc2010-01-04 07:37:31 +0000303 // Scan the array and see if one of our patterns matches.
304 Constant *CompareRHS = cast<Constant>(ICI.getOperand(1));
Chris Lattnerc8d75c72012-01-31 02:55:06 +0000305 for (unsigned i = 0, e = ArrayElementCount; i != e; ++i) {
306 Constant *Elt = Init->getAggregateElement(i);
307 if (Elt == 0) return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000308
Chris Lattner02446fc2010-01-04 07:37:31 +0000309 // If this is indexing an array of structures, get the structure element.
310 if (!LaterIndices.empty())
Jay Foadfc6d3a42011-07-13 10:26:04 +0000311 Elt = ConstantExpr::getExtractValue(Elt, LaterIndices);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000312
Chris Lattner02446fc2010-01-04 07:37:31 +0000313 // If the element is masked, handle it.
314 if (AndCst) Elt = ConstantExpr::getAnd(Elt, AndCst);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000315
Chris Lattner02446fc2010-01-04 07:37:31 +0000316 // Find out if the comparison would be true or false for the i'th element.
317 Constant *C = ConstantFoldCompareInstOperands(ICI.getPredicate(), Elt,
Chad Rosieraab8e282011-12-02 01:26:24 +0000318 CompareRHS, TD, TLI);
Chris Lattner02446fc2010-01-04 07:37:31 +0000319 // If the result is undef for this element, ignore it.
320 if (isa<UndefValue>(C)) {
321 // Extend range state machines to cover this element in case there is an
322 // undef in the middle of the range.
323 if (TrueRangeEnd == (int)i-1)
324 TrueRangeEnd = i;
325 if (FalseRangeEnd == (int)i-1)
326 FalseRangeEnd = i;
327 continue;
328 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000329
Chris Lattner02446fc2010-01-04 07:37:31 +0000330 // If we can't compute the result for any of the elements, we have to give
331 // up evaluating the entire conditional.
332 if (!isa<ConstantInt>(C)) return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000333
Chris Lattner02446fc2010-01-04 07:37:31 +0000334 // Otherwise, we know if the comparison is true or false for this element,
335 // update our state machines.
336 bool IsTrueForElt = !cast<ConstantInt>(C)->isZero();
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000337
Chris Lattner02446fc2010-01-04 07:37:31 +0000338 // State machine for single/double/range index comparison.
339 if (IsTrueForElt) {
340 // Update the TrueElement state machine.
341 if (FirstTrueElement == Undefined)
342 FirstTrueElement = TrueRangeEnd = i; // First true element.
343 else {
344 // Update double-compare state machine.
345 if (SecondTrueElement == Undefined)
346 SecondTrueElement = i;
347 else
348 SecondTrueElement = Overdefined;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000349
Chris Lattner02446fc2010-01-04 07:37:31 +0000350 // Update range state machine.
351 if (TrueRangeEnd == (int)i-1)
352 TrueRangeEnd = i;
353 else
354 TrueRangeEnd = Overdefined;
355 }
356 } else {
357 // Update the FalseElement state machine.
358 if (FirstFalseElement == Undefined)
359 FirstFalseElement = FalseRangeEnd = i; // First false element.
360 else {
361 // Update double-compare state machine.
362 if (SecondFalseElement == Undefined)
363 SecondFalseElement = i;
364 else
365 SecondFalseElement = Overdefined;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000366
Chris Lattner02446fc2010-01-04 07:37:31 +0000367 // Update range state machine.
368 if (FalseRangeEnd == (int)i-1)
369 FalseRangeEnd = i;
370 else
371 FalseRangeEnd = Overdefined;
372 }
373 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000374
375
Chris Lattner02446fc2010-01-04 07:37:31 +0000376 // If this element is in range, update our magic bitvector.
377 if (i < 64 && IsTrueForElt)
378 MagicBitvector |= 1ULL << i;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000379
Chris Lattner02446fc2010-01-04 07:37:31 +0000380 // If all of our states become overdefined, bail out early. Since the
381 // predicate is expensive, only check it every 8 elements. This is only
382 // really useful for really huge arrays.
383 if ((i & 8) == 0 && i >= 64 && SecondTrueElement == Overdefined &&
384 SecondFalseElement == Overdefined && TrueRangeEnd == Overdefined &&
385 FalseRangeEnd == Overdefined)
386 return 0;
387 }
388
389 // Now that we've scanned the entire array, emit our new comparison(s). We
390 // order the state machines in complexity of the generated code.
391 Value *Idx = GEP->getOperand(2);
392
Chris Lattnerd7f5a582010-01-04 18:57:15 +0000393 // If the index is larger than the pointer size of the target, truncate the
394 // index down like the GEP would do implicitly. We don't have to do this for
395 // an inbounds GEP because the index can't be out of range.
396 if (!GEP->isInBounds() &&
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000397 Idx->getType()->getPrimitiveSizeInBits() > TD->getPointerSizeInBits())
Chandler Carruthece6c6b2012-11-01 08:07:29 +0000398 Idx = Builder->CreateTrunc(Idx, TD->getIntPtrType(Idx->getContext()));
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000399
Chris Lattner02446fc2010-01-04 07:37:31 +0000400 // If the comparison is only true for one or two elements, emit direct
401 // comparisons.
402 if (SecondTrueElement != Overdefined) {
403 // None true -> false.
404 if (FirstTrueElement == Undefined)
Jakub Staszak3facc432013-06-06 20:18:46 +0000405 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000406
Chris Lattner02446fc2010-01-04 07:37:31 +0000407 Value *FirstTrueIdx = ConstantInt::get(Idx->getType(), FirstTrueElement);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000408
Chris Lattner02446fc2010-01-04 07:37:31 +0000409 // True for one element -> 'i == 47'.
410 if (SecondTrueElement == Undefined)
411 return new ICmpInst(ICmpInst::ICMP_EQ, Idx, FirstTrueIdx);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000412
Chris Lattner02446fc2010-01-04 07:37:31 +0000413 // True for two elements -> 'i == 47 | i == 72'.
414 Value *C1 = Builder->CreateICmpEQ(Idx, FirstTrueIdx);
415 Value *SecondTrueIdx = ConstantInt::get(Idx->getType(), SecondTrueElement);
416 Value *C2 = Builder->CreateICmpEQ(Idx, SecondTrueIdx);
417 return BinaryOperator::CreateOr(C1, C2);
418 }
419
420 // If the comparison is only false for one or two elements, emit direct
421 // comparisons.
422 if (SecondFalseElement != Overdefined) {
423 // None false -> true.
424 if (FirstFalseElement == Undefined)
Jakub Staszak3facc432013-06-06 20:18:46 +0000425 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000426
Chris Lattner02446fc2010-01-04 07:37:31 +0000427 Value *FirstFalseIdx = ConstantInt::get(Idx->getType(), FirstFalseElement);
428
429 // False for one element -> 'i != 47'.
430 if (SecondFalseElement == Undefined)
431 return new ICmpInst(ICmpInst::ICMP_NE, Idx, FirstFalseIdx);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000432
Chris Lattner02446fc2010-01-04 07:37:31 +0000433 // False for two elements -> 'i != 47 & i != 72'.
434 Value *C1 = Builder->CreateICmpNE(Idx, FirstFalseIdx);
435 Value *SecondFalseIdx = ConstantInt::get(Idx->getType(),SecondFalseElement);
436 Value *C2 = Builder->CreateICmpNE(Idx, SecondFalseIdx);
437 return BinaryOperator::CreateAnd(C1, C2);
438 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000439
Chris Lattner02446fc2010-01-04 07:37:31 +0000440 // If the comparison can be replaced with a range comparison for the elements
441 // where it is true, emit the range check.
442 if (TrueRangeEnd != Overdefined) {
443 assert(TrueRangeEnd != FirstTrueElement && "Should emit single compare");
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000444
Chris Lattner02446fc2010-01-04 07:37:31 +0000445 // Generate (i-FirstTrue) <u (TrueRangeEnd-FirstTrue+1).
446 if (FirstTrueElement) {
447 Value *Offs = ConstantInt::get(Idx->getType(), -FirstTrueElement);
448 Idx = Builder->CreateAdd(Idx, Offs);
449 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000450
Chris Lattner02446fc2010-01-04 07:37:31 +0000451 Value *End = ConstantInt::get(Idx->getType(),
452 TrueRangeEnd-FirstTrueElement+1);
453 return new ICmpInst(ICmpInst::ICMP_ULT, Idx, End);
454 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000455
Chris Lattner02446fc2010-01-04 07:37:31 +0000456 // False range check.
457 if (FalseRangeEnd != Overdefined) {
458 assert(FalseRangeEnd != FirstFalseElement && "Should emit single compare");
459 // Generate (i-FirstFalse) >u (FalseRangeEnd-FirstFalse).
460 if (FirstFalseElement) {
461 Value *Offs = ConstantInt::get(Idx->getType(), -FirstFalseElement);
462 Idx = Builder->CreateAdd(Idx, Offs);
463 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000464
Chris Lattner02446fc2010-01-04 07:37:31 +0000465 Value *End = ConstantInt::get(Idx->getType(),
466 FalseRangeEnd-FirstFalseElement);
467 return new ICmpInst(ICmpInst::ICMP_UGT, Idx, End);
468 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000469
470
Arnaud A. de Grandmaison2be921a2013-03-22 08:25:01 +0000471 // If a magic bitvector captures the entire comparison state
Chris Lattner02446fc2010-01-04 07:37:31 +0000472 // of this load, replace it with computation that does:
473 // ((magic_cst >> i) & 1) != 0
Arnaud A. de Grandmaison2be921a2013-03-22 08:25:01 +0000474 {
475 Type *Ty = 0;
476
477 // Look for an appropriate type:
478 // - The type of Idx if the magic fits
479 // - The smallest fitting legal type if we have a DataLayout
480 // - Default to i32
481 if (ArrayElementCount <= Idx->getType()->getIntegerBitWidth())
482 Ty = Idx->getType();
483 else if (TD)
484 Ty = TD->getSmallestLegalIntType(Init->getContext(), ArrayElementCount);
485 else if (ArrayElementCount <= 32)
Chris Lattner02446fc2010-01-04 07:37:31 +0000486 Ty = Type::getInt32Ty(Init->getContext());
Arnaud A. de Grandmaison2be921a2013-03-22 08:25:01 +0000487
488 if (Ty != 0) {
489 Value *V = Builder->CreateIntCast(Idx, Ty, false);
490 V = Builder->CreateLShr(ConstantInt::get(Ty, MagicBitvector), V);
491 V = Builder->CreateAnd(ConstantInt::get(Ty, 1), V);
492 return new ICmpInst(ICmpInst::ICMP_NE, V, ConstantInt::get(Ty, 0));
493 }
Chris Lattner02446fc2010-01-04 07:37:31 +0000494 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000495
Chris Lattner02446fc2010-01-04 07:37:31 +0000496 return 0;
497}
498
499
500/// EvaluateGEPOffsetExpression - Return a value that can be used to compare
501/// the *offset* implied by a GEP to zero. For example, if we have &A[i], we
502/// want to return 'i' for "icmp ne i, 0". Note that, in general, indices can
503/// be complex, and scales are involved. The above expression would also be
504/// legal to codegen as "icmp ne (i*4), 0" (assuming A is a pointer to i32).
505/// This later form is less amenable to optimization though, and we are allowed
506/// to generate the first by knowing that pointer arithmetic doesn't overflow.
507///
508/// If we can't emit an optimized form for this expression, this returns null.
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000509///
Eli Friedman107ffd52011-05-18 23:11:30 +0000510static Value *EvaluateGEPOffsetExpression(User *GEP, InstCombiner &IC) {
Micah Villmow3574eca2012-10-08 16:38:25 +0000511 DataLayout &TD = *IC.getDataLayout();
Chris Lattner02446fc2010-01-04 07:37:31 +0000512 gep_type_iterator GTI = gep_type_begin(GEP);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000513
Chris Lattner02446fc2010-01-04 07:37:31 +0000514 // Check to see if this gep only has a single variable index. If so, and if
515 // any constant indices are a multiple of its scale, then we can compute this
516 // in terms of the scale of the variable index. For example, if the GEP
517 // implies an offset of "12 + i*4", then we can codegen this as "3 + i",
518 // because the expression will cross zero at the same point.
519 unsigned i, e = GEP->getNumOperands();
520 int64_t Offset = 0;
521 for (i = 1; i != e; ++i, ++GTI) {
522 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
523 // Compute the aggregate offset of constant indices.
524 if (CI->isZero()) continue;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000525
Chris Lattner02446fc2010-01-04 07:37:31 +0000526 // Handle a struct index, which adds its field offset to the pointer.
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000527 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Chris Lattner02446fc2010-01-04 07:37:31 +0000528 Offset += TD.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
529 } else {
530 uint64_t Size = TD.getTypeAllocSize(GTI.getIndexedType());
531 Offset += Size*CI->getSExtValue();
532 }
533 } else {
534 // Found our variable index.
535 break;
536 }
537 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000538
Chris Lattner02446fc2010-01-04 07:37:31 +0000539 // If there are no variable indices, we must have a constant offset, just
540 // evaluate it the general way.
541 if (i == e) return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000542
Chris Lattner02446fc2010-01-04 07:37:31 +0000543 Value *VariableIdx = GEP->getOperand(i);
544 // Determine the scale factor of the variable element. For example, this is
545 // 4 if the variable index is into an array of i32.
546 uint64_t VariableScale = TD.getTypeAllocSize(GTI.getIndexedType());
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000547
Chris Lattner02446fc2010-01-04 07:37:31 +0000548 // Verify that there are no other variable indices. If so, emit the hard way.
549 for (++i, ++GTI; i != e; ++i, ++GTI) {
550 ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i));
551 if (!CI) return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000552
Chris Lattner02446fc2010-01-04 07:37:31 +0000553 // Compute the aggregate offset of constant indices.
554 if (CI->isZero()) continue;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000555
Chris Lattner02446fc2010-01-04 07:37:31 +0000556 // Handle a struct index, which adds its field offset to the pointer.
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000557 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
Chris Lattner02446fc2010-01-04 07:37:31 +0000558 Offset += TD.getStructLayout(STy)->getElementOffset(CI->getZExtValue());
559 } else {
560 uint64_t Size = TD.getTypeAllocSize(GTI.getIndexedType());
561 Offset += Size*CI->getSExtValue();
562 }
563 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000564
Chris Lattner02446fc2010-01-04 07:37:31 +0000565 // Okay, we know we have a single variable index, which must be a
566 // pointer/array/vector index. If there is no offset, life is simple, return
567 // the index.
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000568 unsigned IntPtrWidth = TD.getPointerSizeInBits();
Chris Lattner02446fc2010-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 Friedman107ffd52011-05-18 23:11:30 +0000573 if (VariableIdx->getType()->getPrimitiveSizeInBits() > IntPtrWidth) {
Chandler Carruthece6c6b2012-11-01 08:07:29 +0000574 Type *IntPtrTy = TD.getIntPtrType(VariableIdx->getContext());
Eli Friedman107ffd52011-05-18 23:11:30 +0000575 VariableIdx = IC.Builder->CreateTrunc(VariableIdx, IntPtrTy);
576 }
Chris Lattner02446fc2010-01-04 07:37:31 +0000577 return VariableIdx;
578 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000579
Chris Lattner02446fc2010-01-04 07:37:31 +0000580 // Otherwise, there is an index. The computation we will do will be modulo
581 // the pointer size, so get it.
582 uint64_t PtrSizeMask = ~0ULL >> (64-IntPtrWidth);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000583
Chris Lattner02446fc2010-01-04 07:37:31 +0000584 Offset &= PtrSizeMask;
585 VariableScale &= PtrSizeMask;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000586
Chris Lattner02446fc2010-01-04 07:37:31 +0000587 // To do this transformation, any constant index must be a multiple of the
588 // variable scale factor. For example, we can evaluate "12 + 4*i" as "3 + i",
589 // but we can't evaluate "10 + 3*i" in terms of i. Check that the offset is a
590 // multiple of the variable scale.
591 int64_t NewOffs = Offset / (int64_t)VariableScale;
592 if (Offset != NewOffs*(int64_t)VariableScale)
593 return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000594
Chris Lattner02446fc2010-01-04 07:37:31 +0000595 // Okay, we can do this evaluation. Start by converting the index to intptr.
Chandler Carruthece6c6b2012-11-01 08:07:29 +0000596 Type *IntPtrTy = TD.getIntPtrType(VariableIdx->getContext());
Chris Lattner02446fc2010-01-04 07:37:31 +0000597 if (VariableIdx->getType() != IntPtrTy)
Eli Friedman107ffd52011-05-18 23:11:30 +0000598 VariableIdx = IC.Builder->CreateIntCast(VariableIdx, IntPtrTy,
599 true /*Signed*/);
Chris Lattner02446fc2010-01-04 07:37:31 +0000600 Constant *OffsetVal = ConstantInt::get(IntPtrTy, NewOffs);
Eli Friedman107ffd52011-05-18 23:11:30 +0000601 return IC.Builder->CreateAdd(VariableIdx, OffsetVal, "offset");
Chris Lattner02446fc2010-01-04 07:37:31 +0000602}
603
604/// FoldGEPICmp - Fold comparisons between a GEP instruction and something
605/// else. At this point we know that the GEP is on the LHS of the comparison.
606Instruction *InstCombiner::FoldGEPICmp(GEPOperator *GEPLHS, Value *RHS,
607 ICmpInst::Predicate Cond,
608 Instruction &I) {
Benjamin Kramer8294eb52012-02-21 13:31:09 +0000609 // Don't transform signed compares of GEPs into index compares. Even if the
610 // GEP is inbounds, the final add of the base pointer can have signed overflow
611 // and would change the result of the icmp.
612 // e.g. "&foo[0] <s &foo[1]" can't be folded to "true" because "foo" could be
Benjamin Kramera42d5c42012-02-21 13:40:06 +0000613 // the maximum signed value for the pointer type.
Benjamin Kramer8294eb52012-02-21 13:31:09 +0000614 if (ICmpInst::isSigned(Cond))
615 return 0;
616
Chris Lattner02446fc2010-01-04 07:37:31 +0000617 // Look through bitcasts.
618 if (BitCastInst *BCI = dyn_cast<BitCastInst>(RHS))
619 RHS = BCI->getOperand(0);
620
621 Value *PtrBase = GEPLHS->getOperand(0);
622 if (TD && PtrBase == RHS && GEPLHS->isInBounds()) {
623 // ((gep Ptr, OFFSET) cmp Ptr) ---> (OFFSET cmp 0).
624 // This transformation (ignoring the base and scales) is valid because we
625 // know pointers can't overflow since the gep is inbounds. See if we can
626 // output an optimized form.
Eli Friedman107ffd52011-05-18 23:11:30 +0000627 Value *Offset = EvaluateGEPOffsetExpression(GEPLHS, *this);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000628
Chris Lattner02446fc2010-01-04 07:37:31 +0000629 // If not, synthesize the offset the hard way.
630 if (Offset == 0)
631 Offset = EmitGEPOffset(GEPLHS);
632 return new ICmpInst(ICmpInst::getSignedPredicate(Cond), Offset,
633 Constant::getNullValue(Offset->getType()));
634 } else if (GEPOperator *GEPRHS = dyn_cast<GEPOperator>(RHS)) {
635 // If the base pointers are different, but the indices are the same, just
636 // compare the base pointer.
637 if (PtrBase != GEPRHS->getOperand(0)) {
638 bool IndicesTheSame = GEPLHS->getNumOperands()==GEPRHS->getNumOperands();
639 IndicesTheSame &= GEPLHS->getOperand(0)->getType() ==
640 GEPRHS->getOperand(0)->getType();
641 if (IndicesTheSame)
642 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
643 if (GEPLHS->getOperand(i) != GEPRHS->getOperand(i)) {
644 IndicesTheSame = false;
645 break;
646 }
647
648 // If all indices are the same, just compare the base pointers.
649 if (IndicesTheSame)
David Majnemerc22a4ee2013-06-29 10:28:04 +0000650 return new ICmpInst(Cond, GEPLHS->getOperand(0), GEPRHS->getOperand(0));
Chris Lattner02446fc2010-01-04 07:37:31 +0000651
Benjamin Kramer9bb40852012-02-20 15:07:47 +0000652 // If we're comparing GEPs with two base pointers that only differ in type
653 // and both GEPs have only constant indices or just one use, then fold
654 // the compare with the adjusted indices.
Benjamin Kramer6ad48f42012-02-20 18:45:10 +0000655 if (TD && GEPLHS->isInBounds() && GEPRHS->isInBounds() &&
Benjamin Kramer9bb40852012-02-20 15:07:47 +0000656 (GEPLHS->hasAllConstantIndices() || GEPLHS->hasOneUse()) &&
657 (GEPRHS->hasAllConstantIndices() || GEPRHS->hasOneUse()) &&
658 PtrBase->stripPointerCasts() ==
659 GEPRHS->getOperand(0)->stripPointerCasts()) {
660 Value *Cmp = Builder->CreateICmp(ICmpInst::getSignedPredicate(Cond),
661 EmitGEPOffset(GEPLHS),
662 EmitGEPOffset(GEPRHS));
663 return ReplaceInstUsesWith(I, Cmp);
664 }
665
Chris Lattner02446fc2010-01-04 07:37:31 +0000666 // Otherwise, the base pointers are different and the indices are
667 // different, bail out.
668 return 0;
669 }
670
671 // If one of the GEPs has all zero indices, recurse.
672 bool AllZeros = true;
673 for (unsigned i = 1, e = GEPLHS->getNumOperands(); i != e; ++i)
674 if (!isa<Constant>(GEPLHS->getOperand(i)) ||
675 !cast<Constant>(GEPLHS->getOperand(i))->isNullValue()) {
676 AllZeros = false;
677 break;
678 }
679 if (AllZeros)
680 return FoldGEPICmp(GEPRHS, GEPLHS->getOperand(0),
David Majnemerdf703252013-06-29 09:45:35 +0000681 ICmpInst::getSwappedPredicate(Cond), I);
Chris Lattner02446fc2010-01-04 07:37:31 +0000682
683 // If the other GEP has all zero indices, recurse.
684 AllZeros = true;
685 for (unsigned i = 1, e = GEPRHS->getNumOperands(); i != e; ++i)
686 if (!isa<Constant>(GEPRHS->getOperand(i)) ||
687 !cast<Constant>(GEPRHS->getOperand(i))->isNullValue()) {
688 AllZeros = false;
689 break;
690 }
691 if (AllZeros)
692 return FoldGEPICmp(GEPLHS, GEPRHS->getOperand(0), Cond, I);
693
Stuart Hastings67f071e2011-05-14 05:55:10 +0000694 bool GEPsInBounds = GEPLHS->isInBounds() && GEPRHS->isInBounds();
Chris Lattner02446fc2010-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 Espindola7de80e02013-06-06 17:03:05 +0000712 if (NumDifferences == 0) // SAME GEP?
713 return ReplaceInstUsesWith(I, // No comparison is needed here.
Jakub Staszak3facc432013-06-06 20:18:46 +0000714 Builder->getInt1(ICmpInst::isTrueWhenEqual(Cond)));
Chris Lattner02446fc2010-01-04 07:37:31 +0000715
Stuart Hastings67f071e2011-05-14 05:55:10 +0000716 else if (NumDifferences == 1 && GEPsInBounds) {
Chris Lattner02446fc2010-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!
726 if (TD &&
Stuart Hastings67f071e2011-05-14 05:55:10 +0000727 GEPsInBounds &&
Chris Lattner02446fc2010-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 }
736 return 0;
737}
738
739/// FoldICmpAddOpCst - Fold "icmp pred (X+CI), X".
740Instruction *InstCombiner::FoldICmpAddOpCst(ICmpInst &ICI,
741 Value *X, ConstantInt *CI,
742 ICmpInst::Predicate Pred,
743 Value *TheAdd) {
744 // If we have X+0, exit early (simplifying logic below) and let it get folded
745 // elsewhere. icmp X+0, X -> icmp X, X
746 if (CI->isZero()) {
747 bool isTrue = ICmpInst::isTrueWhenEqual(Pred);
748 return ReplaceInstUsesWith(ICI, ConstantInt::get(ICI.getType(), isTrue));
749 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000750
Chris Lattner02446fc2010-01-04 07:37:31 +0000751 // (X+4) == X -> false.
752 if (Pred == ICmpInst::ICMP_EQ)
Jakub Staszak3facc432013-06-06 20:18:46 +0000753 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner02446fc2010-01-04 07:37:31 +0000754
755 // (X+4) != X -> true.
756 if (Pred == ICmpInst::ICMP_NE)
Jakub Staszak3facc432013-06-06 20:18:46 +0000757 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner02446fc2010-01-04 07:37:31 +0000758
Chris Lattner02446fc2010-01-04 07:37:31 +0000759 // From this point on, we know that (X+C <= X) --> (X+C < X) because C != 0,
Chris Lattner7a2bdde2011-04-15 05:18:47 +0000760 // so the values can never be equal. Similarly for all other "or equals"
Chris Lattner02446fc2010-01-04 07:37:31 +0000761 // operators.
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000762
Chris Lattner9aa1e242010-01-08 17:48:19 +0000763 // (X+1) <u X --> X >u (MAXUINT-1) --> X == 255
Chris Lattner02446fc2010-01-04 07:37:31 +0000764 // (X+2) <u X --> X >u (MAXUINT-2) --> X > 253
765 // (X+MAXUINT) <u X --> X >u (MAXUINT-MAXUINT) --> X != 0
766 if (Pred == ICmpInst::ICMP_ULT || Pred == ICmpInst::ICMP_ULE) {
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000767 Value *R =
Chris Lattner9aa1e242010-01-08 17:48:19 +0000768 ConstantExpr::getSub(ConstantInt::getAllOnesValue(CI->getType()), CI);
Chris Lattner02446fc2010-01-04 07:37:31 +0000769 return new ICmpInst(ICmpInst::ICMP_UGT, X, R);
770 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000771
Chris Lattner02446fc2010-01-04 07:37:31 +0000772 // (X+1) >u X --> X <u (0-1) --> X != 255
773 // (X+2) >u X --> X <u (0-2) --> X <u 254
774 // (X+MAXUINT) >u X --> X <u (0-MAXUINT) --> X <u 1 --> X == 0
Duncan Sandsa7724332011-02-17 07:46:37 +0000775 if (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE)
Chris Lattner02446fc2010-01-04 07:37:31 +0000776 return new ICmpInst(ICmpInst::ICMP_ULT, X, ConstantExpr::getNeg(CI));
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000777
Chris Lattner02446fc2010-01-04 07:37:31 +0000778 unsigned BitWidth = CI->getType()->getPrimitiveSizeInBits();
779 ConstantInt *SMax = ConstantInt::get(X->getContext(),
780 APInt::getSignedMaxValue(BitWidth));
781
782 // (X+ 1) <s X --> X >s (MAXSINT-1) --> X == 127
783 // (X+ 2) <s X --> X >s (MAXSINT-2) --> X >s 125
784 // (X+MAXSINT) <s X --> X >s (MAXSINT-MAXSINT) --> X >s 0
785 // (X+MINSINT) <s X --> X >s (MAXSINT-MINSINT) --> X >s -1
786 // (X+ -2) <s X --> X >s (MAXSINT- -2) --> X >s 126
787 // (X+ -1) <s X --> X >s (MAXSINT- -1) --> X != 127
Duncan Sandsa7724332011-02-17 07:46:37 +0000788 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
Chris Lattner02446fc2010-01-04 07:37:31 +0000789 return new ICmpInst(ICmpInst::ICMP_SGT, X, ConstantExpr::getSub(SMax, CI));
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000790
Chris Lattner02446fc2010-01-04 07:37:31 +0000791 // (X+ 1) >s X --> X <s (MAXSINT-(1-1)) --> X != 127
792 // (X+ 2) >s X --> X <s (MAXSINT-(2-1)) --> X <s 126
793 // (X+MAXSINT) >s X --> X <s (MAXSINT-(MAXSINT-1)) --> X <s 1
794 // (X+MINSINT) >s X --> X <s (MAXSINT-(MINSINT-1)) --> X <s -2
795 // (X+ -2) >s X --> X <s (MAXSINT-(-2-1)) --> X <s -126
796 // (X+ -1) >s X --> X <s (MAXSINT-(-1-1)) --> X == -128
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000797
Chris Lattner02446fc2010-01-04 07:37:31 +0000798 assert(Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE);
Jakub Staszak3facc432013-06-06 20:18:46 +0000799 Constant *C = Builder->getInt(CI->getValue()-1);
Chris Lattner02446fc2010-01-04 07:37:31 +0000800 return new ICmpInst(ICmpInst::ICMP_SLT, X, ConstantExpr::getSub(SMax, C));
801}
802
803/// FoldICmpDivCst - Fold "icmp pred, ([su]div X, DivRHS), CmpRHS" where DivRHS
804/// and CmpRHS are both known to be integer constants.
805Instruction *InstCombiner::FoldICmpDivCst(ICmpInst &ICI, BinaryOperator *DivI,
806 ConstantInt *DivRHS) {
807 ConstantInt *CmpRHS = cast<ConstantInt>(ICI.getOperand(1));
808 const APInt &CmpRHSV = CmpRHS->getValue();
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000809
810 // FIXME: If the operand types don't match the type of the divide
Chris Lattner02446fc2010-01-04 07:37:31 +0000811 // then don't attempt this transform. The code below doesn't have the
812 // logic to deal with a signed divide and an unsigned compare (and
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000813 // vice versa). This is because (x /s C1) <s C2 produces different
Chris Lattner02446fc2010-01-04 07:37:31 +0000814 // results than (x /s C1) <u C2 or (x /u C1) <s C2 or even
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000815 // (x /u C1) <u C2. Simply casting the operands and result won't
816 // work. :( The if statement below tests that condition and bails
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000817 // if it finds it.
Chris Lattner02446fc2010-01-04 07:37:31 +0000818 bool DivIsSigned = DivI->getOpcode() == Instruction::SDiv;
819 if (!ICI.isEquality() && DivIsSigned != ICI.isSigned())
820 return 0;
821 if (DivRHS->isZero())
822 return 0; // The ProdOV computation fails on divide by zero.
823 if (DivIsSigned && DivRHS->isAllOnesValue())
824 return 0; // The overflow computation also screws up here
Chris Lattnerbb75d332011-02-13 08:07:21 +0000825 if (DivRHS->isOne()) {
826 // This eliminates some funny cases with INT_MIN.
827 ICI.setOperand(0, DivI->getOperand(0)); // X/1 == X.
828 return &ICI;
829 }
Chris Lattner02446fc2010-01-04 07:37:31 +0000830
831 // Compute Prod = CI * DivRHS. We are essentially solving an equation
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000832 // of form X/C1=C2. We solve for X by multiplying C1 (DivRHS) and
833 // C2 (CI). By solving for X we can turn this into a range check
834 // instead of computing a divide.
Chris Lattner02446fc2010-01-04 07:37:31 +0000835 Constant *Prod = ConstantExpr::getMul(CmpRHS, DivRHS);
836
837 // Determine if the product overflows by seeing if the product is
838 // not equal to the divide. Make sure we do the same kind of divide
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000839 // as in the LHS instruction that we're folding.
Chris Lattner02446fc2010-01-04 07:37:31 +0000840 bool ProdOV = (DivIsSigned ? ConstantExpr::getSDiv(Prod, DivRHS) :
841 ConstantExpr::getUDiv(Prod, DivRHS)) != CmpRHS;
842
843 // Get the ICmp opcode
844 ICmpInst::Predicate Pred = ICI.getPredicate();
845
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000846 /// If the division is known to be exact, then there is no remainder from the
847 /// divide, so the covered range size is unit, otherwise it is the divisor.
848 ConstantInt *RangeSize = DivI->isExact() ? getOne(Prod) : DivRHS;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000849
Chris Lattner02446fc2010-01-04 07:37:31 +0000850 // Figure out the interval that is being checked. For example, a comparison
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000851 // like "X /u 5 == 0" is really checking that X is in the interval [0, 5).
Chris Lattner02446fc2010-01-04 07:37:31 +0000852 // Compute this interval based on the constants involved and the signedness of
853 // the compare/divide. This computes a half-open interval, keeping track of
854 // whether either value in the interval overflows. After analysis each
855 // overflow variable is set to 0 if it's corresponding bound variable is valid
856 // -1 if overflowed off the bottom end, or +1 if overflowed off the top end.
857 int LoOverflow = 0, HiOverflow = 0;
858 Constant *LoBound = 0, *HiBound = 0;
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000859
Chris Lattner02446fc2010-01-04 07:37:31 +0000860 if (!DivIsSigned) { // udiv
861 // e.g. X/5 op 3 --> [15, 20)
862 LoBound = Prod;
863 HiOverflow = LoOverflow = ProdOV;
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000864 if (!HiOverflow) {
865 // If this is not an exact divide, then many values in the range collapse
866 // to the same result value.
867 HiOverflow = AddWithOverflow(HiBound, LoBound, RangeSize, false);
868 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000869
Chris Lattner02446fc2010-01-04 07:37:31 +0000870 } else if (DivRHS->getValue().isStrictlyPositive()) { // Divisor is > 0.
871 if (CmpRHSV == 0) { // (X / pos) op 0
872 // Can't overflow. e.g. X/2 op 0 --> [-1, 2)
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000873 LoBound = ConstantExpr::getNeg(SubOne(RangeSize));
874 HiBound = RangeSize;
Chris Lattner02446fc2010-01-04 07:37:31 +0000875 } else if (CmpRHSV.isStrictlyPositive()) { // (X / pos) op pos
876 LoBound = Prod; // e.g. X/5 op 3 --> [15, 20)
877 HiOverflow = LoOverflow = ProdOV;
878 if (!HiOverflow)
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000879 HiOverflow = AddWithOverflow(HiBound, Prod, RangeSize, true);
Chris Lattner02446fc2010-01-04 07:37:31 +0000880 } else { // (X / pos) op neg
881 // e.g. X/5 op -3 --> [-15-4, -15+1) --> [-19, -14)
882 HiBound = AddOne(Prod);
883 LoOverflow = HiOverflow = ProdOV ? -1 : 0;
884 if (!LoOverflow) {
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000885 ConstantInt *DivNeg =cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner02446fc2010-01-04 07:37:31 +0000886 LoOverflow = AddWithOverflow(LoBound, HiBound, DivNeg, true) ? -1 : 0;
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000887 }
Chris Lattner02446fc2010-01-04 07:37:31 +0000888 }
Chris Lattnerc73b24d2011-07-15 06:08:15 +0000889 } else if (DivRHS->isNegative()) { // Divisor is < 0.
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000890 if (DivI->isExact())
891 RangeSize = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner02446fc2010-01-04 07:37:31 +0000892 if (CmpRHSV == 0) { // (X / neg) op 0
893 // e.g. X/-5 op 0 --> [-4, 5)
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000894 LoBound = AddOne(RangeSize);
895 HiBound = cast<ConstantInt>(ConstantExpr::getNeg(RangeSize));
Chris Lattner02446fc2010-01-04 07:37:31 +0000896 if (HiBound == DivRHS) { // -INTMIN = INTMIN
897 HiOverflow = 1; // [INTMIN+1, overflow)
898 HiBound = 0; // e.g. X/INTMIN = 0 --> X > INTMIN
899 }
900 } else if (CmpRHSV.isStrictlyPositive()) { // (X / neg) op pos
901 // e.g. X/-5 op 3 --> [-19, -14)
902 HiBound = AddOne(Prod);
903 HiOverflow = LoOverflow = ProdOV ? -1 : 0;
904 if (!LoOverflow)
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000905 LoOverflow = AddWithOverflow(LoBound, HiBound, RangeSize, true) ? -1:0;
Chris Lattner02446fc2010-01-04 07:37:31 +0000906 } else { // (X / neg) op neg
907 LoBound = Prod; // e.g. X/-5 op -3 --> [15, 20)
908 LoOverflow = HiOverflow = ProdOV;
909 if (!HiOverflow)
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000910 HiOverflow = SubWithOverflow(HiBound, Prod, RangeSize, true);
Chris Lattner02446fc2010-01-04 07:37:31 +0000911 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000912
Chris Lattner02446fc2010-01-04 07:37:31 +0000913 // Dividing by a negative swaps the condition. LT <-> GT
914 Pred = ICmpInst::getSwappedPredicate(Pred);
915 }
916
917 Value *X = DivI->getOperand(0);
918 switch (Pred) {
919 default: llvm_unreachable("Unhandled icmp opcode!");
920 case ICmpInst::ICMP_EQ:
921 if (LoOverflow && HiOverflow)
Jakub Staszak3facc432013-06-06 20:18:46 +0000922 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattnerf34f48c2010-03-05 08:46:26 +0000923 if (HiOverflow)
Chris Lattner02446fc2010-01-04 07:37:31 +0000924 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
925 ICmpInst::ICMP_UGE, X, LoBound);
Chris Lattnerf34f48c2010-03-05 08:46:26 +0000926 if (LoOverflow)
Chris Lattner02446fc2010-01-04 07:37:31 +0000927 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
928 ICmpInst::ICMP_ULT, X, HiBound);
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000929 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
930 DivIsSigned, true));
Chris Lattner02446fc2010-01-04 07:37:31 +0000931 case ICmpInst::ICMP_NE:
932 if (LoOverflow && HiOverflow)
Jakub Staszak3facc432013-06-06 20:18:46 +0000933 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattnerf34f48c2010-03-05 08:46:26 +0000934 if (HiOverflow)
Chris Lattner02446fc2010-01-04 07:37:31 +0000935 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SLT :
936 ICmpInst::ICMP_ULT, X, LoBound);
Chris Lattnerf34f48c2010-03-05 08:46:26 +0000937 if (LoOverflow)
Chris Lattner02446fc2010-01-04 07:37:31 +0000938 return new ICmpInst(DivIsSigned ? ICmpInst::ICMP_SGE :
939 ICmpInst::ICMP_UGE, X, HiBound);
Chris Lattnerf34f48c2010-03-05 08:46:26 +0000940 return ReplaceInstUsesWith(ICI, InsertRangeTest(X, LoBound, HiBound,
941 DivIsSigned, false));
Chris Lattner02446fc2010-01-04 07:37:31 +0000942 case ICmpInst::ICMP_ULT:
943 case ICmpInst::ICMP_SLT:
944 if (LoOverflow == +1) // Low bound is greater than input range.
Jakub Staszak3facc432013-06-06 20:18:46 +0000945 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner02446fc2010-01-04 07:37:31 +0000946 if (LoOverflow == -1) // Low bound is less than input range.
Jakub Staszak3facc432013-06-06 20:18:46 +0000947 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner02446fc2010-01-04 07:37:31 +0000948 return new ICmpInst(Pred, X, LoBound);
949 case ICmpInst::ICMP_UGT:
950 case ICmpInst::ICMP_SGT:
951 if (HiOverflow == +1) // High bound greater than input range.
Jakub Staszak3facc432013-06-06 20:18:46 +0000952 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000953 if (HiOverflow == -1) // High bound less than input range.
Jakub Staszak3facc432013-06-06 20:18:46 +0000954 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner02446fc2010-01-04 07:37:31 +0000955 if (Pred == ICmpInst::ICMP_UGT)
956 return new ICmpInst(ICmpInst::ICMP_UGE, X, HiBound);
Chris Lattnerb20c0b52011-02-10 05:23:05 +0000957 return new ICmpInst(ICmpInst::ICMP_SGE, X, HiBound);
Chris Lattner02446fc2010-01-04 07:37:31 +0000958 }
959}
960
Chris Lattner74542aa2011-02-13 07:43:07 +0000961/// FoldICmpShrCst - Handle "icmp(([al]shr X, cst1), cst2)".
962Instruction *InstCombiner::FoldICmpShrCst(ICmpInst &ICI, BinaryOperator *Shr,
963 ConstantInt *ShAmt) {
Chris Lattner74542aa2011-02-13 07:43:07 +0000964 const APInt &CmpRHSV = cast<ConstantInt>(ICI.getOperand(1))->getValue();
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000965
Chris Lattner74542aa2011-02-13 07:43:07 +0000966 // Check that the shift amount is in range. If not, don't perform
967 // undefined shifts. When the shift is visited it will be
968 // simplified.
969 uint32_t TypeBits = CmpRHSV.getBitWidth();
970 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
Chris Lattnerbb75d332011-02-13 08:07:21 +0000971 if (ShAmtVal >= TypeBits || ShAmtVal == 0)
Chris Lattner74542aa2011-02-13 07:43:07 +0000972 return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000973
Chris Lattnerbb75d332011-02-13 08:07:21 +0000974 if (!ICI.isEquality()) {
975 // If we have an unsigned comparison and an ashr, we can't simplify this.
976 // Similarly for signed comparisons with lshr.
977 if (ICI.isSigned() != (Shr->getOpcode() == Instruction::AShr))
978 return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000979
Eli Friedmana831a9b2011-05-25 23:26:20 +0000980 // Otherwise, all lshr and most exact ashr's are equivalent to a udiv/sdiv
981 // by a power of 2. Since we already have logic to simplify these,
982 // transform to div and then simplify the resultant comparison.
Chris Lattnerbb75d332011-02-13 08:07:21 +0000983 if (Shr->getOpcode() == Instruction::AShr &&
Eli Friedmana831a9b2011-05-25 23:26:20 +0000984 (!Shr->isExact() || ShAmtVal == TypeBits - 1))
Chris Lattnerbb75d332011-02-13 08:07:21 +0000985 return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000986
Chris Lattnerbb75d332011-02-13 08:07:21 +0000987 // Revisit the shift (to delete it).
988 Worklist.Add(Shr);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000989
Chris Lattnerbb75d332011-02-13 08:07:21 +0000990 Constant *DivCst =
991 ConstantInt::get(Shr->getType(), APInt::getOneBitSet(TypeBits, ShAmtVal));
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000992
Chris Lattnerbb75d332011-02-13 08:07:21 +0000993 Value *Tmp =
994 Shr->getOpcode() == Instruction::AShr ?
995 Builder->CreateSDiv(Shr->getOperand(0), DivCst, "", Shr->isExact()) :
996 Builder->CreateUDiv(Shr->getOperand(0), DivCst, "", Shr->isExact());
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000997
Chris Lattnerbb75d332011-02-13 08:07:21 +0000998 ICI.setOperand(0, Tmp);
Jim Grosbach0cc4a952011-09-30 18:09:53 +0000999
Chris Lattnerbb75d332011-02-13 08:07:21 +00001000 // If the builder folded the binop, just return it.
1001 BinaryOperator *TheDiv = dyn_cast<BinaryOperator>(Tmp);
1002 if (TheDiv == 0)
1003 return &ICI;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001004
Chris Lattnerbb75d332011-02-13 08:07:21 +00001005 // Otherwise, fold this div/compare.
1006 assert(TheDiv->getOpcode() == Instruction::SDiv ||
1007 TheDiv->getOpcode() == Instruction::UDiv);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001008
Chris Lattnerbb75d332011-02-13 08:07:21 +00001009 Instruction *Res = FoldICmpDivCst(ICI, TheDiv, cast<ConstantInt>(DivCst));
1010 assert(Res && "This div/cst should have folded!");
1011 return Res;
1012 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001013
1014
Chris Lattner74542aa2011-02-13 07:43:07 +00001015 // If we are comparing against bits always shifted out, the
1016 // comparison cannot succeed.
1017 APInt Comp = CmpRHSV << ShAmtVal;
Jakub Staszak3facc432013-06-06 20:18:46 +00001018 ConstantInt *ShiftedCmpRHS = Builder->getInt(Comp);
Chris Lattner74542aa2011-02-13 07:43:07 +00001019 if (Shr->getOpcode() == Instruction::LShr)
1020 Comp = Comp.lshr(ShAmtVal);
1021 else
1022 Comp = Comp.ashr(ShAmtVal);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001023
Chris Lattner74542aa2011-02-13 07:43:07 +00001024 if (Comp != CmpRHSV) { // Comparing against a bit that we know is zero.
1025 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jakub Staszak3facc432013-06-06 20:18:46 +00001026 Constant *Cst = Builder->getInt1(IsICMP_NE);
Chris Lattner74542aa2011-02-13 07:43:07 +00001027 return ReplaceInstUsesWith(ICI, Cst);
1028 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001029
Chris Lattner74542aa2011-02-13 07:43:07 +00001030 // Otherwise, check to see if the bits shifted out are known to be zero.
1031 // If so, we can compare against the unshifted value:
1032 // (X & 4) >> 1 == 2 --> (X & 4) == 4.
Chris Lattnere5116f82011-02-13 18:30:09 +00001033 if (Shr->hasOneUse() && Shr->isExact())
Chris Lattner74542aa2011-02-13 07:43:07 +00001034 return new ICmpInst(ICI.getPredicate(), Shr->getOperand(0), ShiftedCmpRHS);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001035
Chris Lattner74542aa2011-02-13 07:43:07 +00001036 if (Shr->hasOneUse()) {
1037 // Otherwise strength reduce the shift into an and.
1038 APInt Val(APInt::getHighBitsSet(TypeBits, TypeBits - ShAmtVal));
Jakub Staszak3facc432013-06-06 20:18:46 +00001039 Constant *Mask = Builder->getInt(Val);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001040
Chris Lattner74542aa2011-02-13 07:43:07 +00001041 Value *And = Builder->CreateAnd(Shr->getOperand(0),
1042 Mask, Shr->getName()+".mask");
1043 return new ICmpInst(ICI.getPredicate(), And, ShiftedCmpRHS);
1044 }
1045 return 0;
1046}
1047
Chris Lattner02446fc2010-01-04 07:37:31 +00001048
1049/// visitICmpInstWithInstAndIntCst - Handle "icmp (instr, intcst)".
1050///
1051Instruction *InstCombiner::visitICmpInstWithInstAndIntCst(ICmpInst &ICI,
1052 Instruction *LHSI,
1053 ConstantInt *RHS) {
1054 const APInt &RHSV = RHS->getValue();
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001055
Chris Lattner02446fc2010-01-04 07:37:31 +00001056 switch (LHSI->getOpcode()) {
1057 case Instruction::Trunc:
1058 if (ICI.isEquality() && LHSI->hasOneUse()) {
1059 // Simplify icmp eq (trunc x to i8), 42 -> icmp eq x, 42|highbits if all
1060 // of the high bits truncated out of x are known.
1061 unsigned DstBits = LHSI->getType()->getPrimitiveSizeInBits(),
1062 SrcBits = LHSI->getOperand(0)->getType()->getPrimitiveSizeInBits();
Chris Lattner02446fc2010-01-04 07:37:31 +00001063 APInt KnownZero(SrcBits, 0), KnownOne(SrcBits, 0);
Rafael Espindola26c8dcc2012-04-04 12:51:34 +00001064 ComputeMaskedBits(LHSI->getOperand(0), KnownZero, KnownOne);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001065
Chris Lattner02446fc2010-01-04 07:37:31 +00001066 // If all the high bits are known, we can do this xform.
1067 if ((KnownZero|KnownOne).countLeadingOnes() >= SrcBits-DstBits) {
1068 // Pull in the high bits from known-ones set.
Jay Foad40f8f622010-12-07 08:25:19 +00001069 APInt NewRHS = RHS->getValue().zext(SrcBits);
Eli Friedman5b6dfee2012-05-11 01:32:59 +00001070 NewRHS |= KnownOne & APInt::getHighBitsSet(SrcBits, SrcBits-DstBits);
Chris Lattner02446fc2010-01-04 07:37:31 +00001071 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
Jakub Staszak3facc432013-06-06 20:18:46 +00001072 Builder->getInt(NewRHS));
Chris Lattner02446fc2010-01-04 07:37:31 +00001073 }
1074 }
1075 break;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001076
Chris Lattner02446fc2010-01-04 07:37:31 +00001077 case Instruction::Xor: // (icmp pred (xor X, XorCST), CI)
1078 if (ConstantInt *XorCST = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1079 // If this is a comparison that tests the signbit (X < 0) or (x > -1),
1080 // fold the xor.
1081 if ((ICI.getPredicate() == ICmpInst::ICMP_SLT && RHSV == 0) ||
1082 (ICI.getPredicate() == ICmpInst::ICMP_SGT && RHSV.isAllOnesValue())) {
1083 Value *CompareVal = LHSI->getOperand(0);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001084
Chris Lattner02446fc2010-01-04 07:37:31 +00001085 // If the sign bit of the XorCST is not set, there is no change to
1086 // the operation, just stop using the Xor.
Chris Lattnerc73b24d2011-07-15 06:08:15 +00001087 if (!XorCST->isNegative()) {
Chris Lattner02446fc2010-01-04 07:37:31 +00001088 ICI.setOperand(0, CompareVal);
1089 Worklist.Add(LHSI);
1090 return &ICI;
1091 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001092
Chris Lattner02446fc2010-01-04 07:37:31 +00001093 // Was the old condition true if the operand is positive?
1094 bool isTrueIfPositive = ICI.getPredicate() == ICmpInst::ICMP_SGT;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001095
Chris Lattner02446fc2010-01-04 07:37:31 +00001096 // If so, the new one isn't.
1097 isTrueIfPositive ^= true;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001098
Chris Lattner02446fc2010-01-04 07:37:31 +00001099 if (isTrueIfPositive)
1100 return new ICmpInst(ICmpInst::ICMP_SGT, CompareVal,
1101 SubOne(RHS));
1102 else
1103 return new ICmpInst(ICmpInst::ICMP_SLT, CompareVal,
1104 AddOne(RHS));
1105 }
1106
1107 if (LHSI->hasOneUse()) {
1108 // (icmp u/s (xor A SignBit), C) -> (icmp s/u A, (xor C SignBit))
1109 if (!ICI.isEquality() && XorCST->getValue().isSignBit()) {
1110 const APInt &SignBit = XorCST->getValue();
1111 ICmpInst::Predicate Pred = ICI.isSigned()
1112 ? ICI.getUnsignedPredicate()
1113 : ICI.getSignedPredicate();
1114 return new ICmpInst(Pred, LHSI->getOperand(0),
Jakub Staszak3facc432013-06-06 20:18:46 +00001115 Builder->getInt(RHSV ^ SignBit));
Chris Lattner02446fc2010-01-04 07:37:31 +00001116 }
1117
1118 // (icmp u/s (xor A ~SignBit), C) -> (icmp s/u (xor C ~SignBit), A)
Chris Lattnerc73b24d2011-07-15 06:08:15 +00001119 if (!ICI.isEquality() && XorCST->isMaxValue(true)) {
Chris Lattner02446fc2010-01-04 07:37:31 +00001120 const APInt &NotSignBit = XorCST->getValue();
1121 ICmpInst::Predicate Pred = ICI.isSigned()
1122 ? ICI.getUnsignedPredicate()
1123 : ICI.getSignedPredicate();
1124 Pred = ICI.getSwappedPredicate(Pred);
1125 return new ICmpInst(Pred, LHSI->getOperand(0),
Jakub Staszak3facc432013-06-06 20:18:46 +00001126 Builder->getInt(RHSV ^ NotSignBit));
Chris Lattner02446fc2010-01-04 07:37:31 +00001127 }
1128 }
1129 }
1130 break;
1131 case Instruction::And: // (icmp pred (and X, AndCST), RHS)
1132 if (LHSI->hasOneUse() && isa<ConstantInt>(LHSI->getOperand(1)) &&
1133 LHSI->getOperand(0)->hasOneUse()) {
1134 ConstantInt *AndCST = cast<ConstantInt>(LHSI->getOperand(1));
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001135
Chris Lattner02446fc2010-01-04 07:37:31 +00001136 // If the LHS is an AND of a truncating cast, we can widen the
1137 // and/compare to be the input width without changing the value
1138 // produced, eliminating a cast.
1139 if (TruncInst *Cast = dyn_cast<TruncInst>(LHSI->getOperand(0))) {
1140 // We can do this transformation if either the AND constant does not
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001141 // have its sign bit set or if it is an equality comparison.
Chris Lattner02446fc2010-01-04 07:37:31 +00001142 // Extending a relational comparison when we're checking the sign
1143 // bit would not work.
Benjamin Kramer7e7c9cc2011-06-12 22:47:53 +00001144 if (ICI.isEquality() ||
Chris Lattnerc73b24d2011-07-15 06:08:15 +00001145 (!AndCST->isNegative() && RHSV.isNonNegative())) {
Benjamin Kramer7e7c9cc2011-06-12 22:47:53 +00001146 Value *NewAnd =
Chris Lattner02446fc2010-01-04 07:37:31 +00001147 Builder->CreateAnd(Cast->getOperand(0),
Benjamin Kramer7e7c9cc2011-06-12 22:47:53 +00001148 ConstantExpr::getZExt(AndCST, Cast->getSrcTy()));
1149 NewAnd->takeName(LHSI);
Chris Lattner02446fc2010-01-04 07:37:31 +00001150 return new ICmpInst(ICI.getPredicate(), NewAnd,
Benjamin Kramer7e7c9cc2011-06-12 22:47:53 +00001151 ConstantExpr::getZExt(RHS, Cast->getSrcTy()));
Chris Lattner02446fc2010-01-04 07:37:31 +00001152 }
1153 }
Benjamin Kramerffd0ae62011-06-12 22:48:00 +00001154
1155 // If the LHS is an AND of a zext, and we have an equality compare, we can
1156 // shrink the and/compare to the smaller type, eliminating the cast.
1157 if (ZExtInst *Cast = dyn_cast<ZExtInst>(LHSI->getOperand(0))) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001158 IntegerType *Ty = cast<IntegerType>(Cast->getSrcTy());
Benjamin Kramerffd0ae62011-06-12 22:48:00 +00001159 // Make sure we don't compare the upper bits, SimplifyDemandedBits
1160 // should fold the icmp to true/false in that case.
1161 if (ICI.isEquality() && RHSV.getActiveBits() <= Ty->getBitWidth()) {
1162 Value *NewAnd =
1163 Builder->CreateAnd(Cast->getOperand(0),
1164 ConstantExpr::getTrunc(AndCST, Ty));
1165 NewAnd->takeName(LHSI);
1166 return new ICmpInst(ICI.getPredicate(), NewAnd,
1167 ConstantExpr::getTrunc(RHS, Ty));
1168 }
1169 }
1170
Chris Lattner02446fc2010-01-04 07:37:31 +00001171 // If this is: (X >> C1) & C2 != C3 (where any shift and any compare
1172 // could exist), turn it into (X & (C2 << C1)) != (C3 << C1). This
1173 // happens a LOT in code produced by the C front-end, for bitfield
1174 // access.
1175 BinaryOperator *Shift = dyn_cast<BinaryOperator>(LHSI->getOperand(0));
1176 if (Shift && !Shift->isShift())
1177 Shift = 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001178
Chris Lattner02446fc2010-01-04 07:37:31 +00001179 ConstantInt *ShAmt;
1180 ShAmt = Shift ? dyn_cast<ConstantInt>(Shift->getOperand(1)) : 0;
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001181 Type *Ty = Shift ? Shift->getType() : 0; // Type of the shift.
1182 Type *AndTy = AndCST->getType(); // Type of the and.
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001183
Chris Lattner02446fc2010-01-04 07:37:31 +00001184 // We can fold this as long as we can't shift unknown bits
1185 // into the mask. This can only happen with signed shift
1186 // rights, as they sign-extend.
1187 if (ShAmt) {
1188 bool CanFold = Shift->isLogicalShift();
1189 if (!CanFold) {
1190 // To test for the bad case of the signed shr, see if any
1191 // of the bits shifted in could be tested after the mask.
1192 uint32_t TyBits = Ty->getPrimitiveSizeInBits();
1193 int ShAmtVal = TyBits - ShAmt->getLimitedValue(TyBits);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001194
Chris Lattner02446fc2010-01-04 07:37:31 +00001195 uint32_t BitWidth = AndTy->getPrimitiveSizeInBits();
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001196 if ((APInt::getHighBitsSet(BitWidth, BitWidth-ShAmtVal) &
Chris Lattner02446fc2010-01-04 07:37:31 +00001197 AndCST->getValue()) == 0)
1198 CanFold = true;
1199 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001200
Chris Lattner02446fc2010-01-04 07:37:31 +00001201 if (CanFold) {
1202 Constant *NewCst;
1203 if (Shift->getOpcode() == Instruction::Shl)
1204 NewCst = ConstantExpr::getLShr(RHS, ShAmt);
1205 else
1206 NewCst = ConstantExpr::getShl(RHS, ShAmt);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001207
Chris Lattner02446fc2010-01-04 07:37:31 +00001208 // Check to see if we are shifting out any of the bits being
1209 // compared.
1210 if (ConstantExpr::get(Shift->getOpcode(),
1211 NewCst, ShAmt) != RHS) {
1212 // If we shifted bits out, the fold is not going to work out.
1213 // As a special case, check to see if this means that the
1214 // result is always true or false now.
1215 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
Jakub Staszak3facc432013-06-06 20:18:46 +00001216 return ReplaceInstUsesWith(ICI, Builder->getFalse());
Chris Lattner02446fc2010-01-04 07:37:31 +00001217 if (ICI.getPredicate() == ICmpInst::ICMP_NE)
Jakub Staszak3facc432013-06-06 20:18:46 +00001218 return ReplaceInstUsesWith(ICI, Builder->getTrue());
Chris Lattner02446fc2010-01-04 07:37:31 +00001219 } else {
1220 ICI.setOperand(1, NewCst);
1221 Constant *NewAndCST;
1222 if (Shift->getOpcode() == Instruction::Shl)
1223 NewAndCST = ConstantExpr::getLShr(AndCST, ShAmt);
1224 else
1225 NewAndCST = ConstantExpr::getShl(AndCST, ShAmt);
1226 LHSI->setOperand(1, NewAndCST);
1227 LHSI->setOperand(0, Shift->getOperand(0));
1228 Worklist.Add(Shift); // Shift is dead.
1229 return &ICI;
1230 }
1231 }
1232 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001233
Chris Lattner02446fc2010-01-04 07:37:31 +00001234 // Turn ((X >> Y) & C) == 0 into (X & (C << Y)) == 0. The later is
1235 // preferable because it allows the C<<Y expression to be hoisted out
1236 // of a loop if Y is invariant and X is not.
1237 if (Shift && Shift->hasOneUse() && RHSV == 0 &&
1238 ICI.isEquality() && !Shift->isArithmeticShift() &&
1239 !isa<Constant>(Shift->getOperand(0))) {
1240 // Compute C << Y.
1241 Value *NS;
1242 if (Shift->getOpcode() == Instruction::LShr) {
Benjamin Kramera9390a42011-09-27 20:39:19 +00001243 NS = Builder->CreateShl(AndCST, Shift->getOperand(1));
Chris Lattner02446fc2010-01-04 07:37:31 +00001244 } else {
1245 // Insert a logical shift.
Benjamin Kramera9390a42011-09-27 20:39:19 +00001246 NS = Builder->CreateLShr(AndCST, Shift->getOperand(1));
Chris Lattner02446fc2010-01-04 07:37:31 +00001247 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001248
Chris Lattner02446fc2010-01-04 07:37:31 +00001249 // Compute X & (C << Y).
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001250 Value *NewAnd =
Chris Lattner02446fc2010-01-04 07:37:31 +00001251 Builder->CreateAnd(Shift->getOperand(0), NS, LHSI->getName());
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001252
Chris Lattner02446fc2010-01-04 07:37:31 +00001253 ICI.setOperand(0, NewAnd);
1254 return &ICI;
1255 }
Paul Redmond6da2e222012-12-19 19:47:13 +00001256
1257 // Replace ((X & AndCST) > RHSV) with ((X & AndCST) != 0), if any
1258 // bit set in (X & AndCST) will produce a result greater than RHSV.
1259 if (ICI.getPredicate() == ICmpInst::ICMP_UGT) {
1260 unsigned NTZ = AndCST->getValue().countTrailingZeros();
1261 if ((NTZ < AndCST->getBitWidth()) &&
1262 APInt::getOneBitSet(AndCST->getBitWidth(), NTZ).ugt(RHSV))
1263 return new ICmpInst(ICmpInst::ICMP_NE, LHSI,
1264 Constant::getNullValue(RHS->getType()));
1265 }
Chris Lattner02446fc2010-01-04 07:37:31 +00001266 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001267
Chris Lattner02446fc2010-01-04 07:37:31 +00001268 // Try to optimize things like "A[i]&42 == 0" to index computations.
1269 if (LoadInst *LI = dyn_cast<LoadInst>(LHSI->getOperand(0))) {
1270 if (GetElementPtrInst *GEP =
1271 dyn_cast<GetElementPtrInst>(LI->getOperand(0)))
1272 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
1273 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
1274 !LI->isVolatile() && isa<ConstantInt>(LHSI->getOperand(1))) {
1275 ConstantInt *C = cast<ConstantInt>(LHSI->getOperand(1));
1276 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV,ICI, C))
1277 return Res;
1278 }
1279 }
1280 break;
1281
1282 case Instruction::Or: {
1283 if (!ICI.isEquality() || !RHS->isNullValue() || !LHSI->hasOneUse())
1284 break;
1285 Value *P, *Q;
1286 if (match(LHSI, m_Or(m_PtrToInt(m_Value(P)), m_PtrToInt(m_Value(Q))))) {
1287 // Simplify icmp eq (or (ptrtoint P), (ptrtoint Q)), 0
1288 // -> and (icmp eq P, null), (icmp eq Q, null).
Chris Lattner02446fc2010-01-04 07:37:31 +00001289 Value *ICIP = Builder->CreateICmp(ICI.getPredicate(), P,
1290 Constant::getNullValue(P->getType()));
1291 Value *ICIQ = Builder->CreateICmp(ICI.getPredicate(), Q,
1292 Constant::getNullValue(Q->getType()));
1293 Instruction *Op;
1294 if (ICI.getPredicate() == ICmpInst::ICMP_EQ)
1295 Op = BinaryOperator::CreateAnd(ICIP, ICIQ);
1296 else
1297 Op = BinaryOperator::CreateOr(ICIP, ICIQ);
1298 return Op;
1299 }
1300 break;
1301 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001302
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +00001303 case Instruction::Mul: { // (icmp pred (mul X, Val), CI)
1304 ConstantInt *Val = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1305 if (!Val) break;
1306
Arnaud A. de Grandmaison1bb93a92013-03-25 11:47:38 +00001307 // If this is a signed comparison to 0 and the mul is sign preserving,
1308 // use the mul LHS operand instead.
1309 ICmpInst::Predicate pred = ICI.getPredicate();
1310 if (isSignTest(pred, RHS) && !Val->isZero() &&
1311 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1312 return new ICmpInst(Val->isNegative() ?
1313 ICmpInst::getSwappedPredicate(pred) : pred,
1314 LHSI->getOperand(0),
1315 Constant::getNullValue(RHS->getType()));
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +00001316
1317 break;
1318 }
1319
Chris Lattner02446fc2010-01-04 07:37:31 +00001320 case Instruction::Shl: { // (icmp pred (shl X, ShAmt), CI)
Chris Lattner02446fc2010-01-04 07:37:31 +00001321 uint32_t TypeBits = RHSV.getBitWidth();
David Majnemerb41f4bb2013-06-28 23:42:03 +00001322 ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1323 if (!ShAmt) {
1324 Value *X;
1325 // (1 << X) pred P2 -> X pred Log2(P2)
1326 if (match(LHSI, m_Shl(m_One(), m_Value(X)))) {
1327 bool RHSVIsPowerOf2 = RHSV.isPowerOf2();
1328 ICmpInst::Predicate Pred = ICI.getPredicate();
1329 if (ICI.isUnsigned()) {
1330 if (!RHSVIsPowerOf2) {
1331 // (1 << X) < 30 -> X <= 4
1332 // (1 << X) <= 30 -> X <= 4
1333 // (1 << X) >= 30 -> X > 4
1334 // (1 << X) > 30 -> X > 4
1335 if (Pred == ICmpInst::ICMP_ULT)
1336 Pred = ICmpInst::ICMP_ULE;
1337 else if (Pred == ICmpInst::ICMP_UGE)
1338 Pred = ICmpInst::ICMP_UGT;
1339 }
1340 unsigned RHSLog2 = RHSV.logBase2();
1341
1342 // (1 << X) >= 2147483648 -> X >= 31 -> X == 31
1343 // (1 << X) > 2147483648 -> X > 31 -> false
1344 // (1 << X) <= 2147483648 -> X <= 31 -> true
1345 // (1 << X) < 2147483648 -> X < 31 -> X != 31
1346 if (RHSLog2 == TypeBits-1) {
1347 if (Pred == ICmpInst::ICMP_UGE)
1348 Pred = ICmpInst::ICMP_EQ;
1349 else if (Pred == ICmpInst::ICMP_UGT)
1350 return ReplaceInstUsesWith(ICI, Builder->getFalse());
1351 else if (Pred == ICmpInst::ICMP_ULE)
1352 return ReplaceInstUsesWith(ICI, Builder->getTrue());
1353 else if (Pred == ICmpInst::ICMP_ULT)
1354 Pred = ICmpInst::ICMP_NE;
1355 }
1356
1357 return new ICmpInst(Pred, X,
1358 ConstantInt::get(RHS->getType(), RHSLog2));
1359 } else if (ICI.isSigned()) {
1360 if (RHSV.isAllOnesValue()) {
1361 // (1 << X) <= -1 -> X == 31
1362 if (Pred == ICmpInst::ICMP_SLE)
1363 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1364 ConstantInt::get(RHS->getType(), TypeBits-1));
1365
1366 // (1 << X) > -1 -> X != 31
1367 if (Pred == ICmpInst::ICMP_SGT)
1368 return new ICmpInst(ICmpInst::ICMP_NE, X,
1369 ConstantInt::get(RHS->getType(), TypeBits-1));
1370 } else if (!RHSV) {
1371 // (1 << X) < 0 -> X == 31
1372 // (1 << X) <= 0 -> X == 31
1373 if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE)
1374 return new ICmpInst(ICmpInst::ICMP_EQ, X,
1375 ConstantInt::get(RHS->getType(), TypeBits-1));
1376
1377 // (1 << X) >= 0 -> X != 31
1378 // (1 << X) > 0 -> X != 31
1379 if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE)
1380 return new ICmpInst(ICmpInst::ICMP_NE, X,
1381 ConstantInt::get(RHS->getType(), TypeBits-1));
1382 }
1383 } else if (ICI.isEquality()) {
1384 if (RHSVIsPowerOf2)
1385 return new ICmpInst(
1386 Pred, X, ConstantInt::get(RHS->getType(), RHSV.logBase2()));
1387
1388 return ReplaceInstUsesWith(
1389 ICI, Pred == ICmpInst::ICMP_EQ ? Builder->getFalse()
1390 : Builder->getTrue());
1391 }
1392 }
1393 break;
1394 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001395
Chris Lattner02446fc2010-01-04 07:37:31 +00001396 // Check that the shift amount is in range. If not, don't perform
1397 // undefined shifts. When the shift is visited it will be
1398 // simplified.
1399 if (ShAmt->uge(TypeBits))
1400 break;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001401
Chris Lattner02446fc2010-01-04 07:37:31 +00001402 if (ICI.isEquality()) {
1403 // If we are comparing against bits always shifted out, the
1404 // comparison cannot succeed.
1405 Constant *Comp =
1406 ConstantExpr::getShl(ConstantExpr::getLShr(RHS, ShAmt),
1407 ShAmt);
1408 if (Comp != RHS) {// Comparing against a bit that we know is zero.
1409 bool IsICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jakub Staszak3facc432013-06-06 20:18:46 +00001410 Constant *Cst = Builder->getInt1(IsICMP_NE);
Chris Lattner02446fc2010-01-04 07:37:31 +00001411 return ReplaceInstUsesWith(ICI, Cst);
1412 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001413
Chris Lattnerb20c0b52011-02-10 05:23:05 +00001414 // If the shift is NUW, then it is just shifting out zeros, no need for an
1415 // AND.
1416 if (cast<BinaryOperator>(LHSI)->hasNoUnsignedWrap())
1417 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1418 ConstantExpr::getLShr(RHS, ShAmt));
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001419
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +00001420 // If the shift is NSW and we compare to 0, then it is just shifting out
1421 // sign bits, no need for an AND either.
1422 if (cast<BinaryOperator>(LHSI)->hasNoSignedWrap() && RHSV == 0)
1423 return new ICmpInst(ICI.getPredicate(), LHSI->getOperand(0),
1424 ConstantExpr::getLShr(RHS, ShAmt));
1425
Chris Lattner02446fc2010-01-04 07:37:31 +00001426 if (LHSI->hasOneUse()) {
1427 // Otherwise strength reduce the shift into an and.
1428 uint32_t ShAmtVal = (uint32_t)ShAmt->getLimitedValue(TypeBits);
Jakub Staszak3facc432013-06-06 20:18:46 +00001429 Constant *Mask = Builder->getInt(APInt::getLowBitsSet(TypeBits,
1430 TypeBits - ShAmtVal));
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001431
Chris Lattner02446fc2010-01-04 07:37:31 +00001432 Value *And =
1433 Builder->CreateAnd(LHSI->getOperand(0),Mask, LHSI->getName()+".mask");
1434 return new ICmpInst(ICI.getPredicate(), And,
Chris Lattnerb20c0b52011-02-10 05:23:05 +00001435 ConstantExpr::getLShr(RHS, ShAmt));
Chris Lattner02446fc2010-01-04 07:37:31 +00001436 }
1437 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001438
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +00001439 // If this is a signed comparison to 0 and the shift is sign preserving,
1440 // use the shift LHS operand instead.
1441 ICmpInst::Predicate pred = ICI.getPredicate();
1442 if (isSignTest(pred, RHS) &&
1443 cast<BinaryOperator>(LHSI)->hasNoSignedWrap())
1444 return new ICmpInst(pred,
1445 LHSI->getOperand(0),
1446 Constant::getNullValue(RHS->getType()));
1447
Chris Lattner02446fc2010-01-04 07:37:31 +00001448 // Otherwise, if this is a comparison of the sign bit, simplify to and/test.
1449 bool TrueIfSigned = false;
1450 if (LHSI->hasOneUse() &&
1451 isSignBitCheck(ICI.getPredicate(), RHS, TrueIfSigned)) {
1452 // (X << 31) <s 0 --> (X&1) != 0
Chris Lattnerbb75d332011-02-13 08:07:21 +00001453 Constant *Mask = ConstantInt::get(LHSI->getOperand(0)->getType(),
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001454 APInt::getOneBitSet(TypeBits,
Chris Lattnerbb75d332011-02-13 08:07:21 +00001455 TypeBits-ShAmt->getZExtValue()-1));
Chris Lattner02446fc2010-01-04 07:37:31 +00001456 Value *And =
1457 Builder->CreateAnd(LHSI->getOperand(0), Mask, LHSI->getName()+".mask");
1458 return new ICmpInst(TrueIfSigned ? ICmpInst::ICMP_NE : ICmpInst::ICMP_EQ,
1459 And, Constant::getNullValue(And->getType()));
1460 }
Arnaud A. de Grandmaison7c5c9b32013-02-15 14:35:47 +00001461
1462 // Transform (icmp pred iM (shl iM %v, N), CI)
Arnaud A. de Grandmaisonbdd2d982013-03-13 14:40:37 +00001463 // -> (icmp pred i(M-N) (trunc %v iM to i(M-N)), (trunc (CI>>N))
1464 // Transform the shl to a trunc if (trunc (CI>>N)) has no loss and M-N.
Arnaud A. de Grandmaison7c5c9b32013-02-15 14:35:47 +00001465 // This enables to get rid of the shift in favor of a trunc which can be
1466 // free on the target. It has the additional benefit of comparing to a
1467 // smaller constant, which will be target friendly.
1468 unsigned Amt = ShAmt->getLimitedValue(TypeBits-1);
Arnaud A. de Grandmaisonbdd2d982013-03-13 14:40:37 +00001469 if (LHSI->hasOneUse() &&
1470 Amt != 0 && RHSV.countTrailingZeros() >= Amt) {
Arnaud A. de Grandmaison7c5c9b32013-02-15 14:35:47 +00001471 Type *NTy = IntegerType::get(ICI.getContext(), TypeBits - Amt);
1472 Constant *NCI = ConstantExpr::getTrunc(
1473 ConstantExpr::getAShr(RHS,
1474 ConstantInt::get(RHS->getType(), Amt)),
1475 NTy);
1476 return new ICmpInst(ICI.getPredicate(),
1477 Builder->CreateTrunc(LHSI->getOperand(0), NTy),
Arnaud A. de Grandmaisonad079b22013-02-15 15:18:17 +00001478 NCI);
Arnaud A. de Grandmaison7c5c9b32013-02-15 14:35:47 +00001479 }
1480
Chris Lattner02446fc2010-01-04 07:37:31 +00001481 break;
1482 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001483
Chris Lattner02446fc2010-01-04 07:37:31 +00001484 case Instruction::LShr: // (icmp pred (shr X, ShAmt), CI)
Nick Lewyckyb042f8e2011-02-28 08:31:40 +00001485 case Instruction::AShr: {
1486 // Handle equality comparisons of shift-by-constant.
1487 BinaryOperator *BO = cast<BinaryOperator>(LHSI);
1488 if (ConstantInt *ShAmt = dyn_cast<ConstantInt>(LHSI->getOperand(1))) {
1489 if (Instruction *Res = FoldICmpShrCst(ICI, BO, ShAmt))
Chris Lattner74542aa2011-02-13 07:43:07 +00001490 return Res;
Nick Lewyckyb042f8e2011-02-28 08:31:40 +00001491 }
1492
1493 // Handle exact shr's.
1494 if (ICI.isEquality() && BO->isExact() && BO->hasOneUse()) {
1495 if (RHSV.isMinValue())
1496 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0), RHS);
1497 }
Chris Lattner02446fc2010-01-04 07:37:31 +00001498 break;
Nick Lewyckyb042f8e2011-02-28 08:31:40 +00001499 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001500
Chris Lattner02446fc2010-01-04 07:37:31 +00001501 case Instruction::SDiv:
1502 case Instruction::UDiv:
1503 // Fold: icmp pred ([us]div X, C1), C2 -> range test
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001504 // Fold this div into the comparison, producing a range check.
1505 // Determine, based on the divide type, what the range is being
1506 // checked. If there is an overflow on the low or high side, remember
Chris Lattner02446fc2010-01-04 07:37:31 +00001507 // it, otherwise compute the range [low, hi) bounding the new value.
1508 // See: InsertRangeTest above for the kinds of replacements possible.
1509 if (ConstantInt *DivRHS = dyn_cast<ConstantInt>(LHSI->getOperand(1)))
1510 if (Instruction *R = FoldICmpDivCst(ICI, cast<BinaryOperator>(LHSI),
1511 DivRHS))
1512 return R;
1513 break;
1514
David Majnemer377a5c12013-07-09 07:50:59 +00001515 case Instruction::Sub: {
1516 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(0));
1517 if (!LHSC) break;
1518 const APInt &LHSV = LHSC->getValue();
1519
1520 // C1-X <u C2 -> (X|(C2-1)) == C1
1521 // iff C1 & (C2-1) == C2-1
1522 // C2 is a power of 2
1523 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
1524 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == (RHSV - 1))
1525 return new ICmpInst(ICmpInst::ICMP_EQ,
1526 Builder->CreateOr(LHSI->getOperand(1), RHSV - 1),
1527 LHSC);
1528
1529 // C1-X >u C2 -> (X|C2) == C1
1530 // iff C1 & C2 == C2
1531 // C2+1 is a power of 2
1532 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1533 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == RHSV)
1534 return new ICmpInst(ICmpInst::ICMP_NE,
1535 Builder->CreateOr(LHSI->getOperand(1), RHSV), LHSC);
1536 break;
1537 }
1538
Chris Lattner02446fc2010-01-04 07:37:31 +00001539 case Instruction::Add:
1540 // Fold: icmp pred (add X, C1), C2
1541 if (!ICI.isEquality()) {
1542 ConstantInt *LHSC = dyn_cast<ConstantInt>(LHSI->getOperand(1));
1543 if (!LHSC) break;
1544 const APInt &LHSV = LHSC->getValue();
1545
1546 ConstantRange CR = ICI.makeConstantRange(ICI.getPredicate(), RHSV)
1547 .subtract(LHSV);
1548
1549 if (ICI.isSigned()) {
1550 if (CR.getLower().isSignBit()) {
1551 return new ICmpInst(ICmpInst::ICMP_SLT, LHSI->getOperand(0),
Jakub Staszak3facc432013-06-06 20:18:46 +00001552 Builder->getInt(CR.getUpper()));
Chris Lattner02446fc2010-01-04 07:37:31 +00001553 } else if (CR.getUpper().isSignBit()) {
1554 return new ICmpInst(ICmpInst::ICMP_SGE, LHSI->getOperand(0),
Jakub Staszak3facc432013-06-06 20:18:46 +00001555 Builder->getInt(CR.getLower()));
Chris Lattner02446fc2010-01-04 07:37:31 +00001556 }
1557 } else {
1558 if (CR.getLower().isMinValue()) {
1559 return new ICmpInst(ICmpInst::ICMP_ULT, LHSI->getOperand(0),
Jakub Staszak3facc432013-06-06 20:18:46 +00001560 Builder->getInt(CR.getUpper()));
Chris Lattner02446fc2010-01-04 07:37:31 +00001561 } else if (CR.getUpper().isMinValue()) {
1562 return new ICmpInst(ICmpInst::ICMP_UGE, LHSI->getOperand(0),
Jakub Staszak3facc432013-06-06 20:18:46 +00001563 Builder->getInt(CR.getLower()));
Chris Lattner02446fc2010-01-04 07:37:31 +00001564 }
1565 }
David Majnemer53fc3992013-07-08 11:53:08 +00001566
David Majnemer11c29ba2013-07-09 07:58:32 +00001567 // X-C1 <u C2 -> (X & -C2) == C1
1568 // iff C1 & (C2-1) == 0
1569 // C2 is a power of 2
David Majnemer53fc3992013-07-08 11:53:08 +00001570 if (ICI.getPredicate() == ICmpInst::ICMP_ULT && LHSI->hasOneUse() &&
David Majnemer11c29ba2013-07-09 07:58:32 +00001571 RHSV.isPowerOf2() && (LHSV & (RHSV - 1)) == 0)
David Majnemer53fc3992013-07-08 11:53:08 +00001572 return new ICmpInst(ICmpInst::ICMP_EQ,
1573 Builder->CreateAnd(LHSI->getOperand(0), -RHSV),
1574 ConstantExpr::getNeg(LHSC));
David Majnemer11c29ba2013-07-09 07:58:32 +00001575
1576 // X-C1 >u C2 -> (X & ~C2) == C1
1577 // iff C1 & C2 == 0
1578 // C2+1 is a power of 2
1579 if (ICI.getPredicate() == ICmpInst::ICMP_UGT && LHSI->hasOneUse() &&
1580 (RHSV + 1).isPowerOf2() && (LHSV & RHSV) == 0)
1581 return new ICmpInst(ICmpInst::ICMP_NE,
1582 Builder->CreateAnd(LHSI->getOperand(0), ~RHSV),
1583 ConstantExpr::getNeg(LHSC));
Chris Lattner02446fc2010-01-04 07:37:31 +00001584 }
1585 break;
1586 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001587
Chris Lattner02446fc2010-01-04 07:37:31 +00001588 // Simplify icmp_eq and icmp_ne instructions with integer constant RHS.
1589 if (ICI.isEquality()) {
1590 bool isICMP_NE = ICI.getPredicate() == ICmpInst::ICMP_NE;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001591
1592 // If the first operand is (add|sub|and|or|xor|rem) with a constant, and
Chris Lattner02446fc2010-01-04 07:37:31 +00001593 // the second operand is a constant, simplify a bit.
1594 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(LHSI)) {
1595 switch (BO->getOpcode()) {
1596 case Instruction::SRem:
1597 // If we have a signed (X % (2^c)) == 0, turn it into an unsigned one.
1598 if (RHSV == 0 && isa<ConstantInt>(BO->getOperand(1)) &&BO->hasOneUse()){
1599 const APInt &V = cast<ConstantInt>(BO->getOperand(1))->getValue();
Dan Gohmane0567812010-04-08 23:03:40 +00001600 if (V.sgt(1) && V.isPowerOf2()) {
Chris Lattner02446fc2010-01-04 07:37:31 +00001601 Value *NewRem =
1602 Builder->CreateURem(BO->getOperand(0), BO->getOperand(1),
1603 BO->getName());
1604 return new ICmpInst(ICI.getPredicate(), NewRem,
1605 Constant::getNullValue(BO->getType()));
1606 }
1607 }
1608 break;
1609 case Instruction::Add:
1610 // Replace ((add A, B) != C) with (A != C-B) if B & C are constants.
1611 if (ConstantInt *BOp1C = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1612 if (BO->hasOneUse())
1613 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1614 ConstantExpr::getSub(RHS, BOp1C));
1615 } else if (RHSV == 0) {
1616 // Replace ((add A, B) != 0) with (A != -B) if A or B is
1617 // efficiently invertible, or if the add has just this one use.
1618 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001619
Chris Lattner02446fc2010-01-04 07:37:31 +00001620 if (Value *NegVal = dyn_castNegVal(BOp1))
1621 return new ICmpInst(ICI.getPredicate(), BOp0, NegVal);
Chris Lattner5036ce42011-04-26 20:02:45 +00001622 if (Value *NegVal = dyn_castNegVal(BOp0))
Chris Lattner02446fc2010-01-04 07:37:31 +00001623 return new ICmpInst(ICI.getPredicate(), NegVal, BOp1);
Chris Lattner5036ce42011-04-26 20:02:45 +00001624 if (BO->hasOneUse()) {
Chris Lattner02446fc2010-01-04 07:37:31 +00001625 Value *Neg = Builder->CreateNeg(BOp1);
1626 Neg->takeName(BO);
1627 return new ICmpInst(ICI.getPredicate(), BOp0, Neg);
1628 }
1629 }
1630 break;
1631 case Instruction::Xor:
1632 // For the xor case, we can xor two constants together, eliminating
1633 // the explicit xor.
Benjamin Kramere7fdcad2011-06-13 15:24:24 +00001634 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
1635 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
Chris Lattner02446fc2010-01-04 07:37:31 +00001636 ConstantExpr::getXor(RHS, BOC));
Benjamin Kramere7fdcad2011-06-13 15:24:24 +00001637 } else if (RHSV == 0) {
1638 // Replace ((xor A, B) != 0) with (A != B)
Chris Lattner02446fc2010-01-04 07:37:31 +00001639 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1640 BO->getOperand(1));
Benjamin Kramere7fdcad2011-06-13 15:24:24 +00001641 }
Chris Lattner02446fc2010-01-04 07:37:31 +00001642 break;
Benjamin Kramere7fdcad2011-06-13 15:24:24 +00001643 case Instruction::Sub:
1644 // Replace ((sub A, B) != C) with (B != A-C) if A & C are constants.
1645 if (ConstantInt *BOp0C = dyn_cast<ConstantInt>(BO->getOperand(0))) {
1646 if (BO->hasOneUse())
1647 return new ICmpInst(ICI.getPredicate(), BO->getOperand(1),
1648 ConstantExpr::getSub(BOp0C, RHS));
1649 } else if (RHSV == 0) {
1650 // Replace ((sub A, B) != 0) with (A != B)
1651 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1652 BO->getOperand(1));
1653 }
1654 break;
Chris Lattner02446fc2010-01-04 07:37:31 +00001655 case Instruction::Or:
1656 // If bits are being or'd in that are not present in the constant we
1657 // are comparing against, then the comparison could never succeed!
Eli Friedman618898e2010-07-29 18:03:33 +00001658 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
Chris Lattner02446fc2010-01-04 07:37:31 +00001659 Constant *NotCI = ConstantExpr::getNot(RHS);
1660 if (!ConstantExpr::getAnd(BOC, NotCI)->isNullValue())
Jakub Staszak3facc432013-06-06 20:18:46 +00001661 return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
Chris Lattner02446fc2010-01-04 07:37:31 +00001662 }
1663 break;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001664
Chris Lattner02446fc2010-01-04 07:37:31 +00001665 case Instruction::And:
1666 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1667 // If bits are being compared against that are and'd out, then the
1668 // comparison can never succeed!
1669 if ((RHSV & ~BOC->getValue()) != 0)
Jakub Staszak3facc432013-06-06 20:18:46 +00001670 return ReplaceInstUsesWith(ICI, Builder->getInt1(isICMP_NE));
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001671
Chris Lattner02446fc2010-01-04 07:37:31 +00001672 // If we have ((X & C) == C), turn it into ((X & C) != 0).
1673 if (RHS == BOC && RHSV.isPowerOf2())
1674 return new ICmpInst(isICMP_NE ? ICmpInst::ICMP_EQ :
1675 ICmpInst::ICMP_NE, LHSI,
1676 Constant::getNullValue(RHS->getType()));
Benjamin Kramerfc87cdc2011-07-04 20:16:36 +00001677
1678 // Don't perform the following transforms if the AND has multiple uses
1679 if (!BO->hasOneUse())
1680 break;
1681
Chris Lattner02446fc2010-01-04 07:37:31 +00001682 // Replace (and X, (1 << size(X)-1) != 0) with x s< 0
1683 if (BOC->getValue().isSignBit()) {
1684 Value *X = BO->getOperand(0);
1685 Constant *Zero = Constant::getNullValue(X->getType());
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001686 ICmpInst::Predicate pred = isICMP_NE ?
Chris Lattner02446fc2010-01-04 07:37:31 +00001687 ICmpInst::ICMP_SLT : ICmpInst::ICMP_SGE;
1688 return new ICmpInst(pred, X, Zero);
1689 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001690
Chris Lattner02446fc2010-01-04 07:37:31 +00001691 // ((X & ~7) == 0) --> X < 8
1692 if (RHSV == 0 && isHighOnes(BOC)) {
1693 Value *X = BO->getOperand(0);
1694 Constant *NegX = ConstantExpr::getNeg(BOC);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001695 ICmpInst::Predicate pred = isICMP_NE ?
Chris Lattner02446fc2010-01-04 07:37:31 +00001696 ICmpInst::ICMP_UGE : ICmpInst::ICMP_ULT;
1697 return new ICmpInst(pred, X, NegX);
1698 }
1699 }
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +00001700 break;
1701 case Instruction::Mul:
Arnaud A. de Grandmaison1bb93a92013-03-25 11:47:38 +00001702 if (RHSV == 0 && BO->hasNoSignedWrap()) {
Arnaud A. de Grandmaison35763b12013-03-25 09:48:49 +00001703 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
1704 // The trivial case (mul X, 0) is handled by InstSimplify
1705 // General case : (mul X, C) != 0 iff X != 0
1706 // (mul X, C) == 0 iff X == 0
1707 if (!BOC->isZero())
1708 return new ICmpInst(ICI.getPredicate(), BO->getOperand(0),
1709 Constant::getNullValue(RHS->getType()));
1710 }
1711 }
1712 break;
Chris Lattner02446fc2010-01-04 07:37:31 +00001713 default: break;
1714 }
1715 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(LHSI)) {
1716 // Handle icmp {eq|ne} <intrinsic>, intcst.
Chris Lattner03357402010-01-05 18:09:56 +00001717 switch (II->getIntrinsicID()) {
1718 case Intrinsic::bswap:
Chris Lattner02446fc2010-01-04 07:37:31 +00001719 Worklist.Add(II);
Gabor Greifcaf70b32010-06-24 16:11:44 +00001720 ICI.setOperand(0, II->getArgOperand(0));
Jakub Staszak3facc432013-06-06 20:18:46 +00001721 ICI.setOperand(1, Builder->getInt(RHSV.byteSwap()));
Chris Lattner02446fc2010-01-04 07:37:31 +00001722 return &ICI;
Chris Lattner03357402010-01-05 18:09:56 +00001723 case Intrinsic::ctlz:
1724 case Intrinsic::cttz:
1725 // ctz(A) == bitwidth(a) -> A == 0 and likewise for !=
1726 if (RHSV == RHS->getType()->getBitWidth()) {
1727 Worklist.Add(II);
Gabor Greifcaf70b32010-06-24 16:11:44 +00001728 ICI.setOperand(0, II->getArgOperand(0));
Chris Lattner03357402010-01-05 18:09:56 +00001729 ICI.setOperand(1, ConstantInt::get(RHS->getType(), 0));
1730 return &ICI;
1731 }
1732 break;
1733 case Intrinsic::ctpop:
1734 // popcount(A) == 0 -> A == 0 and likewise for !=
1735 if (RHS->isZero()) {
1736 Worklist.Add(II);
Gabor Greifcaf70b32010-06-24 16:11:44 +00001737 ICI.setOperand(0, II->getArgOperand(0));
Chris Lattner03357402010-01-05 18:09:56 +00001738 ICI.setOperand(1, RHS);
1739 return &ICI;
1740 }
1741 break;
1742 default:
Duncan Sands34727662010-07-12 08:16:59 +00001743 break;
Chris Lattner02446fc2010-01-04 07:37:31 +00001744 }
1745 }
1746 }
1747 return 0;
1748}
1749
1750/// visitICmpInstWithCastAndCast - Handle icmp (cast x to y), (cast/cst).
1751/// We only handle extending casts so far.
1752///
1753Instruction *InstCombiner::visitICmpInstWithCastAndCast(ICmpInst &ICI) {
1754 const CastInst *LHSCI = cast<CastInst>(ICI.getOperand(0));
1755 Value *LHSCIOp = LHSCI->getOperand(0);
Chris Lattnerdb125cf2011-07-18 04:54:35 +00001756 Type *SrcTy = LHSCIOp->getType();
1757 Type *DestTy = LHSCI->getType();
Chris Lattner02446fc2010-01-04 07:37:31 +00001758 Value *RHSCIOp;
1759
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001760 // Turn icmp (ptrtoint x), (ptrtoint/c) into a compare of the input if the
Chris Lattner02446fc2010-01-04 07:37:31 +00001761 // integer type is the same size as the pointer type.
1762 if (TD && LHSCI->getOpcode() == Instruction::PtrToInt &&
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001763 TD->getPointerSizeInBits() ==
Chris Lattner02446fc2010-01-04 07:37:31 +00001764 cast<IntegerType>(DestTy)->getBitWidth()) {
1765 Value *RHSOp = 0;
1766 if (Constant *RHSC = dyn_cast<Constant>(ICI.getOperand(1))) {
1767 RHSOp = ConstantExpr::getIntToPtr(RHSC, SrcTy);
1768 } else if (PtrToIntInst *RHSC = dyn_cast<PtrToIntInst>(ICI.getOperand(1))) {
1769 RHSOp = RHSC->getOperand(0);
1770 // If the pointer types don't match, insert a bitcast.
1771 if (LHSCIOp->getType() != RHSOp->getType())
1772 RHSOp = Builder->CreateBitCast(RHSOp, LHSCIOp->getType());
1773 }
1774
1775 if (RHSOp)
1776 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSOp);
1777 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001778
Chris Lattner02446fc2010-01-04 07:37:31 +00001779 // The code below only handles extension cast instructions, so far.
1780 // Enforce this.
1781 if (LHSCI->getOpcode() != Instruction::ZExt &&
1782 LHSCI->getOpcode() != Instruction::SExt)
1783 return 0;
1784
1785 bool isSignedExt = LHSCI->getOpcode() == Instruction::SExt;
1786 bool isSignedCmp = ICI.isSigned();
1787
1788 if (CastInst *CI = dyn_cast<CastInst>(ICI.getOperand(1))) {
1789 // Not an extension from the same type?
1790 RHSCIOp = CI->getOperand(0);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001791 if (RHSCIOp->getType() != LHSCIOp->getType())
Chris Lattner02446fc2010-01-04 07:37:31 +00001792 return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001793
Chris Lattner02446fc2010-01-04 07:37:31 +00001794 // If the signedness of the two casts doesn't agree (i.e. one is a sext
1795 // and the other is a zext), then we can't handle this.
1796 if (CI->getOpcode() != LHSCI->getOpcode())
1797 return 0;
1798
1799 // Deal with equality cases early.
1800 if (ICI.isEquality())
1801 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1802
1803 // A signed comparison of sign extended values simplifies into a
1804 // signed comparison.
1805 if (isSignedCmp && isSignedExt)
1806 return new ICmpInst(ICI.getPredicate(), LHSCIOp, RHSCIOp);
1807
1808 // The other three cases all fold into an unsigned comparison.
1809 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, RHSCIOp);
1810 }
1811
1812 // If we aren't dealing with a constant on the RHS, exit early
1813 ConstantInt *CI = dyn_cast<ConstantInt>(ICI.getOperand(1));
1814 if (!CI)
1815 return 0;
1816
1817 // Compute the constant that would happen if we truncated to SrcTy then
1818 // reextended to DestTy.
1819 Constant *Res1 = ConstantExpr::getTrunc(CI, SrcTy);
1820 Constant *Res2 = ConstantExpr::getCast(LHSCI->getOpcode(),
1821 Res1, DestTy);
1822
1823 // If the re-extended constant didn't change...
1824 if (Res2 == CI) {
1825 // Deal with equality cases early.
1826 if (ICI.isEquality())
1827 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1828
1829 // A signed comparison of sign extended values simplifies into a
1830 // signed comparison.
1831 if (isSignedExt && isSignedCmp)
1832 return new ICmpInst(ICI.getPredicate(), LHSCIOp, Res1);
1833
1834 // The other three cases all fold into an unsigned comparison.
1835 return new ICmpInst(ICI.getUnsignedPredicate(), LHSCIOp, Res1);
1836 }
1837
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001838 // The re-extended constant changed so the constant cannot be represented
Chris Lattner02446fc2010-01-04 07:37:31 +00001839 // in the shorter type. Consequently, we cannot emit a simple comparison.
Duncan Sands9d32f602011-01-20 13:21:55 +00001840 // All the cases that fold to true or false will have already been handled
1841 // by SimplifyICmpInst, so only deal with the tricky case.
Chris Lattner02446fc2010-01-04 07:37:31 +00001842
Duncan Sands9d32f602011-01-20 13:21:55 +00001843 if (isSignedCmp || !isSignedExt)
1844 return 0;
Chris Lattner02446fc2010-01-04 07:37:31 +00001845
1846 // Evaluate the comparison for LT (we invert for GT below). LE and GE cases
1847 // should have been folded away previously and not enter in here.
Duncan Sands9d32f602011-01-20 13:21:55 +00001848
1849 // We're performing an unsigned comp with a sign extended value.
1850 // This is true if the input is >= 0. [aka >s -1]
1851 Constant *NegOne = Constant::getAllOnesValue(SrcTy);
1852 Value *Result = Builder->CreateICmpSGT(LHSCIOp, NegOne, ICI.getName());
Chris Lattner02446fc2010-01-04 07:37:31 +00001853
1854 // Finally, return the value computed.
Duncan Sands9d32f602011-01-20 13:21:55 +00001855 if (ICI.getPredicate() == ICmpInst::ICMP_ULT)
Chris Lattner02446fc2010-01-04 07:37:31 +00001856 return ReplaceInstUsesWith(ICI, Result);
1857
Duncan Sands9d32f602011-01-20 13:21:55 +00001858 assert(ICI.getPredicate() == ICmpInst::ICMP_UGT && "ICmp should be folded!");
Chris Lattner02446fc2010-01-04 07:37:31 +00001859 return BinaryOperator::CreateNot(Result);
1860}
1861
Chris Lattnerf0f568b2010-12-19 17:52:50 +00001862/// ProcessUGT_ADDCST_ADD - The caller has matched a pattern of the form:
1863/// I = icmp ugt (add (add A, B), CI2), CI1
Chris Lattnerdd7e8372010-12-19 18:22:06 +00001864/// If this is of the form:
1865/// sum = a + b
1866/// if (sum+128 >u 255)
1867/// Then replace it with llvm.sadd.with.overflow.i8.
1868///
Chris Lattnerf0f568b2010-12-19 17:52:50 +00001869static Instruction *ProcessUGT_ADDCST_ADD(ICmpInst &I, Value *A, Value *B,
1870 ConstantInt *CI2, ConstantInt *CI1,
Chris Lattner0fe80bb2010-12-19 18:38:44 +00001871 InstCombiner &IC) {
Chris Lattner368397b2010-12-19 17:59:02 +00001872 // The transformation we're trying to do here is to transform this into an
1873 // llvm.sadd.with.overflow. To do this, we have to replace the original add
1874 // with a narrower add, and discard the add-with-constant that is part of the
1875 // range check (if we can't eliminate it, this isn't profitable).
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001876
Chris Lattner368397b2010-12-19 17:59:02 +00001877 // In order to eliminate the add-with-constant, the compare can be its only
1878 // use.
Chris Lattnerdd7e8372010-12-19 18:22:06 +00001879 Instruction *AddWithCst = cast<Instruction>(I.getOperand(0));
Chris Lattner368397b2010-12-19 17:59:02 +00001880 if (!AddWithCst->hasOneUse()) return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001881
Chris Lattnerdd7e8372010-12-19 18:22:06 +00001882 // If CI2 is 2^7, 2^15, 2^31, then it might be an sadd.with.overflow.
1883 if (!CI2->getValue().isPowerOf2()) return 0;
1884 unsigned NewWidth = CI2->getValue().countTrailingZeros();
1885 if (NewWidth != 7 && NewWidth != 15 && NewWidth != 31) return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001886
Chris Lattnerdd7e8372010-12-19 18:22:06 +00001887 // The width of the new add formed is 1 more than the bias.
1888 ++NewWidth;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001889
Chris Lattnerdd7e8372010-12-19 18:22:06 +00001890 // Check to see that CI1 is an all-ones value with NewWidth bits.
1891 if (CI1->getBitWidth() == NewWidth ||
1892 CI1->getValue() != APInt::getLowBitsSet(CI1->getBitWidth(), NewWidth))
1893 return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001894
Eli Friedman54b92112011-11-28 23:32:19 +00001895 // This is only really a signed overflow check if the inputs have been
1896 // sign-extended; check for that condition. For example, if CI2 is 2^31 and
1897 // the operands of the add are 64 bits wide, we need at least 33 sign bits.
1898 unsigned NeededSignBits = CI1->getBitWidth() - NewWidth + 1;
1899 if (IC.ComputeNumSignBits(A) < NeededSignBits ||
1900 IC.ComputeNumSignBits(B) < NeededSignBits)
1901 return 0;
1902
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001903 // In order to replace the original add with a narrower
Chris Lattnerdd7e8372010-12-19 18:22:06 +00001904 // llvm.sadd.with.overflow, the only uses allowed are the add-with-constant
1905 // and truncates that discard the high bits of the add. Verify that this is
1906 // the case.
1907 Instruction *OrigAdd = cast<Instruction>(AddWithCst->getOperand(0));
1908 for (Value::use_iterator UI = OrigAdd->use_begin(), E = OrigAdd->use_end();
1909 UI != E; ++UI) {
1910 if (*UI == AddWithCst) continue;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001911
Chris Lattnerdd7e8372010-12-19 18:22:06 +00001912 // Only accept truncates for now. We would really like a nice recursive
1913 // predicate like SimplifyDemandedBits, but which goes downwards the use-def
1914 // chain to see which bits of a value are actually demanded. If the
1915 // original add had another add which was then immediately truncated, we
1916 // could still do the transformation.
1917 TruncInst *TI = dyn_cast<TruncInst>(*UI);
1918 if (TI == 0 ||
1919 TI->getType()->getPrimitiveSizeInBits() > NewWidth) return 0;
1920 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001921
Chris Lattnerf0f568b2010-12-19 17:52:50 +00001922 // If the pattern matches, truncate the inputs to the narrower type and
1923 // use the sadd_with_overflow intrinsic to efficiently compute both the
1924 // result and the overflow bit.
Chris Lattner0a624742010-12-19 18:35:09 +00001925 Module *M = I.getParent()->getParent()->getParent();
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001926
Jay Foad5fdd6c82011-07-12 14:06:48 +00001927 Type *NewType = IntegerType::get(OrigAdd->getContext(), NewWidth);
Chris Lattner0a624742010-12-19 18:35:09 +00001928 Value *F = Intrinsic::getDeclaration(M, Intrinsic::sadd_with_overflow,
Benjamin Kramereb9a85f2011-07-14 17:45:39 +00001929 NewType);
Chris Lattner0a624742010-12-19 18:35:09 +00001930
Chris Lattner0fe80bb2010-12-19 18:38:44 +00001931 InstCombiner::BuilderTy *Builder = IC.Builder;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001932
Chris Lattner0a624742010-12-19 18:35:09 +00001933 // Put the new code above the original add, in case there are any uses of the
1934 // add between the add and the compare.
Chris Lattnere5cbdca2010-12-19 19:37:52 +00001935 Builder->SetInsertPoint(OrigAdd);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001936
Chris Lattner0a624742010-12-19 18:35:09 +00001937 Value *TruncA = Builder->CreateTrunc(A, NewType, A->getName()+".trunc");
1938 Value *TruncB = Builder->CreateTrunc(B, NewType, B->getName()+".trunc");
1939 CallInst *Call = Builder->CreateCall2(F, TruncA, TruncB, "sadd");
1940 Value *Add = Builder->CreateExtractValue(Call, 0, "sadd.result");
1941 Value *ZExt = Builder->CreateZExt(Add, OrigAdd->getType());
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001942
Chris Lattnerf0f568b2010-12-19 17:52:50 +00001943 // The inner add was the result of the narrow add, zero extended to the
1944 // wider type. Replace it with the result computed by the intrinsic.
Chris Lattner0fe80bb2010-12-19 18:38:44 +00001945 IC.ReplaceInstUsesWith(*OrigAdd, ZExt);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001946
Chris Lattner0a624742010-12-19 18:35:09 +00001947 // The original icmp gets replaced with the overflow value.
1948 return ExtractValueInst::Create(Call, 1, "sadd.overflow");
Chris Lattnerf0f568b2010-12-19 17:52:50 +00001949}
Chris Lattner02446fc2010-01-04 07:37:31 +00001950
Chris Lattnere5cbdca2010-12-19 19:37:52 +00001951static Instruction *ProcessUAddIdiom(Instruction &I, Value *OrigAddV,
1952 InstCombiner &IC) {
1953 // Don't bother doing this transformation for pointers, don't do it for
1954 // vectors.
1955 if (!isa<IntegerType>(OrigAddV->getType())) return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001956
Chris Lattnere5cbdca2010-12-19 19:37:52 +00001957 // If the add is a constant expr, then we don't bother transforming it.
1958 Instruction *OrigAdd = dyn_cast<Instruction>(OrigAddV);
1959 if (OrigAdd == 0) return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001960
Chris Lattnere5cbdca2010-12-19 19:37:52 +00001961 Value *LHS = OrigAdd->getOperand(0), *RHS = OrigAdd->getOperand(1);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001962
Chris Lattnere5cbdca2010-12-19 19:37:52 +00001963 // Put the new code above the original add, in case there are any uses of the
1964 // add between the add and the compare.
1965 InstCombiner::BuilderTy *Builder = IC.Builder;
1966 Builder->SetInsertPoint(OrigAdd);
1967
1968 Module *M = I.getParent()->getParent()->getParent();
Jay Foad5fdd6c82011-07-12 14:06:48 +00001969 Type *Ty = LHS->getType();
Benjamin Kramereb9a85f2011-07-14 17:45:39 +00001970 Value *F = Intrinsic::getDeclaration(M, Intrinsic::uadd_with_overflow, Ty);
Chris Lattnere5cbdca2010-12-19 19:37:52 +00001971 CallInst *Call = Builder->CreateCall2(F, LHS, RHS, "uadd");
1972 Value *Add = Builder->CreateExtractValue(Call, 0);
1973
1974 IC.ReplaceInstUsesWith(*OrigAdd, Add);
1975
1976 // The original icmp gets replaced with the overflow value.
1977 return ExtractValueInst::Create(Call, 1, "uadd.overflow");
1978}
1979
Owen Andersonda1c1222011-01-11 00:36:45 +00001980// DemandedBitsLHSMask - When performing a comparison against a constant,
1981// it is possible that not all the bits in the LHS are demanded. This helper
1982// method computes the mask that IS demanded.
1983static APInt DemandedBitsLHSMask(ICmpInst &I,
1984 unsigned BitWidth, bool isSignCheck) {
1985 if (isSignCheck)
1986 return APInt::getSignBit(BitWidth);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001987
Owen Andersonda1c1222011-01-11 00:36:45 +00001988 ConstantInt *CI = dyn_cast<ConstantInt>(I.getOperand(1));
1989 if (!CI) return APInt::getAllOnesValue(BitWidth);
Owen Andersona33b6252011-01-11 18:26:37 +00001990 const APInt &RHS = CI->getValue();
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001991
Owen Andersonda1c1222011-01-11 00:36:45 +00001992 switch (I.getPredicate()) {
Jim Grosbach0cc4a952011-09-30 18:09:53 +00001993 // For a UGT comparison, we don't care about any bits that
Owen Andersonda1c1222011-01-11 00:36:45 +00001994 // correspond to the trailing ones of the comparand. The value of these
1995 // bits doesn't impact the outcome of the comparison, because any value
1996 // greater than the RHS must differ in a bit higher than these due to carry.
1997 case ICmpInst::ICMP_UGT: {
1998 unsigned trailingOnes = RHS.countTrailingOnes();
1999 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingOnes);
2000 return ~lowBitsSet;
2001 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002002
Owen Andersonda1c1222011-01-11 00:36:45 +00002003 // Similarly, for a ULT comparison, we don't care about the trailing zeros.
2004 // Any value less than the RHS must differ in a higher bit because of carries.
2005 case ICmpInst::ICMP_ULT: {
2006 unsigned trailingZeros = RHS.countTrailingZeros();
2007 APInt lowBitsSet = APInt::getLowBitsSet(BitWidth, trailingZeros);
2008 return ~lowBitsSet;
2009 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002010
Owen Andersonda1c1222011-01-11 00:36:45 +00002011 default:
2012 return APInt::getAllOnesValue(BitWidth);
2013 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002014
Owen Andersonda1c1222011-01-11 00:36:45 +00002015}
Chris Lattner02446fc2010-01-04 07:37:31 +00002016
2017Instruction *InstCombiner::visitICmpInst(ICmpInst &I) {
2018 bool Changed = false;
Chris Lattner5f670d42010-02-01 19:54:45 +00002019 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002020
Chris Lattner02446fc2010-01-04 07:37:31 +00002021 /// Orders the operands of the compare so that they are listed from most
2022 /// complex to least complex. This puts constants before unary operators,
2023 /// before binary operators.
Chris Lattner5f670d42010-02-01 19:54:45 +00002024 if (getComplexity(Op0) < getComplexity(Op1)) {
Chris Lattner02446fc2010-01-04 07:37:31 +00002025 I.swapOperands();
Chris Lattner5f670d42010-02-01 19:54:45 +00002026 std::swap(Op0, Op1);
Chris Lattner02446fc2010-01-04 07:37:31 +00002027 Changed = true;
2028 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002029
Chris Lattner02446fc2010-01-04 07:37:31 +00002030 if (Value *V = SimplifyICmpInst(I.getPredicate(), Op0, Op1, TD))
2031 return ReplaceInstUsesWith(I, V);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002032
Pete Cooper65a6b572011-12-01 03:58:40 +00002033 // comparing -val or val with non-zero is the same as just comparing val
Pete Cooper165695d2011-12-01 19:13:26 +00002034 // ie, abs(val) != 0 -> val != 0
Pete Cooper65a6b572011-12-01 03:58:40 +00002035 if (I.getPredicate() == ICmpInst::ICMP_NE && match(Op1, m_Zero()))
2036 {
Pete Cooper165695d2011-12-01 19:13:26 +00002037 Value *Cond, *SelectTrue, *SelectFalse;
2038 if (match(Op0, m_Select(m_Value(Cond), m_Value(SelectTrue),
Pete Cooper65a6b572011-12-01 03:58:40 +00002039 m_Value(SelectFalse)))) {
Pete Cooper165695d2011-12-01 19:13:26 +00002040 if (Value *V = dyn_castNegVal(SelectTrue)) {
2041 if (V == SelectFalse)
2042 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
2043 }
2044 else if (Value *V = dyn_castNegVal(SelectFalse)) {
2045 if (V == SelectTrue)
2046 return CmpInst::Create(Instruction::ICmp, I.getPredicate(), V, Op1);
Pete Cooper65a6b572011-12-01 03:58:40 +00002047 }
2048 }
2049 }
2050
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002051 Type *Ty = Op0->getType();
Chris Lattner02446fc2010-01-04 07:37:31 +00002052
2053 // icmp's with boolean values can always be turned into bitwise operations
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00002054 if (Ty->isIntegerTy(1)) {
Chris Lattner02446fc2010-01-04 07:37:31 +00002055 switch (I.getPredicate()) {
2056 default: llvm_unreachable("Invalid icmp instruction!");
2057 case ICmpInst::ICMP_EQ: { // icmp eq i1 A, B -> ~(A^B)
2058 Value *Xor = Builder->CreateXor(Op0, Op1, I.getName()+"tmp");
2059 return BinaryOperator::CreateNot(Xor);
2060 }
2061 case ICmpInst::ICMP_NE: // icmp eq i1 A, B -> A^B
2062 return BinaryOperator::CreateXor(Op0, Op1);
2063
2064 case ICmpInst::ICMP_UGT:
2065 std::swap(Op0, Op1); // Change icmp ugt -> icmp ult
2066 // FALL THROUGH
2067 case ICmpInst::ICMP_ULT:{ // icmp ult i1 A, B -> ~A & B
2068 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2069 return BinaryOperator::CreateAnd(Not, Op1);
2070 }
2071 case ICmpInst::ICMP_SGT:
2072 std::swap(Op0, Op1); // Change icmp sgt -> icmp slt
2073 // FALL THROUGH
2074 case ICmpInst::ICMP_SLT: { // icmp slt i1 A, B -> A & ~B
2075 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2076 return BinaryOperator::CreateAnd(Not, Op0);
2077 }
2078 case ICmpInst::ICMP_UGE:
2079 std::swap(Op0, Op1); // Change icmp uge -> icmp ule
2080 // FALL THROUGH
2081 case ICmpInst::ICMP_ULE: { // icmp ule i1 A, B -> ~A | B
2082 Value *Not = Builder->CreateNot(Op0, I.getName()+"tmp");
2083 return BinaryOperator::CreateOr(Not, Op1);
2084 }
2085 case ICmpInst::ICMP_SGE:
2086 std::swap(Op0, Op1); // Change icmp sge -> icmp sle
2087 // FALL THROUGH
2088 case ICmpInst::ICMP_SLE: { // icmp sle i1 A, B -> A | ~B
2089 Value *Not = Builder->CreateNot(Op1, I.getName()+"tmp");
2090 return BinaryOperator::CreateOr(Not, Op0);
2091 }
2092 }
2093 }
2094
2095 unsigned BitWidth = 0;
Chris Lattnere5cbdca2010-12-19 19:37:52 +00002096 if (Ty->isIntOrIntVectorTy())
Chris Lattner02446fc2010-01-04 07:37:31 +00002097 BitWidth = Ty->getScalarSizeInBits();
Chris Lattnere5cbdca2010-12-19 19:37:52 +00002098 else if (TD) // Pointers require TD info to get their size.
2099 BitWidth = TD->getTypeSizeInBits(Ty->getScalarType());
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002100
Chris Lattner02446fc2010-01-04 07:37:31 +00002101 bool isSignBit = false;
2102
2103 // See if we are doing a comparison with a constant.
2104 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2105 Value *A = 0, *B = 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002106
Owen Andersone63dda52010-12-17 18:08:00 +00002107 // Match the following pattern, which is a common idiom when writing
2108 // overflow-safe integer arithmetic function. The source performs an
2109 // addition in wider type, and explicitly checks for overflow using
2110 // comparisons against INT_MIN and INT_MAX. Simplify this by using the
2111 // sadd_with_overflow intrinsic.
Chris Lattnerf0f568b2010-12-19 17:52:50 +00002112 //
2113 // TODO: This could probably be generalized to handle other overflow-safe
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002114 // operations if we worked out the formulas to compute the appropriate
Owen Andersone63dda52010-12-17 18:08:00 +00002115 // magic constants.
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002116 //
Chris Lattnerf0f568b2010-12-19 17:52:50 +00002117 // sum = a + b
2118 // if (sum+128 >u 255) ... -> llvm.sadd.with.overflow.i8
Owen Andersone63dda52010-12-17 18:08:00 +00002119 {
Chris Lattnerf0f568b2010-12-19 17:52:50 +00002120 ConstantInt *CI2; // I = icmp ugt (add (add A, B), CI2), CI
Owen Andersone63dda52010-12-17 18:08:00 +00002121 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
Chris Lattnerf0f568b2010-12-19 17:52:50 +00002122 match(Op0, m_Add(m_Add(m_Value(A), m_Value(B)), m_ConstantInt(CI2))))
Chris Lattner0fe80bb2010-12-19 18:38:44 +00002123 if (Instruction *Res = ProcessUGT_ADDCST_ADD(I, A, B, CI2, CI, *this))
Chris Lattnerf0f568b2010-12-19 17:52:50 +00002124 return Res;
Owen Andersone63dda52010-12-17 18:08:00 +00002125 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002126
Chris Lattner02446fc2010-01-04 07:37:31 +00002127 // (icmp ne/eq (sub A B) 0) -> (icmp ne/eq A, B)
2128 if (I.isEquality() && CI->isZero() &&
2129 match(Op0, m_Sub(m_Value(A), m_Value(B)))) {
2130 // (icmp cond A B) if cond is equality
2131 return new ICmpInst(I.getPredicate(), A, B);
2132 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002133
Chris Lattner02446fc2010-01-04 07:37:31 +00002134 // If we have an icmp le or icmp ge instruction, turn it into the
2135 // appropriate icmp lt or icmp gt instruction. This allows us to rely on
2136 // them being folded in the code below. The SimplifyICmpInst code has
2137 // already handled the edge cases for us, so we just assert on them.
2138 switch (I.getPredicate()) {
2139 default: break;
2140 case ICmpInst::ICMP_ULE:
2141 assert(!CI->isMaxValue(false)); // A <=u MAX -> TRUE
2142 return new ICmpInst(ICmpInst::ICMP_ULT, Op0,
Jakub Staszak3facc432013-06-06 20:18:46 +00002143 Builder->getInt(CI->getValue()+1));
Chris Lattner02446fc2010-01-04 07:37:31 +00002144 case ICmpInst::ICMP_SLE:
2145 assert(!CI->isMaxValue(true)); // A <=s MAX -> TRUE
2146 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
Jakub Staszak3facc432013-06-06 20:18:46 +00002147 Builder->getInt(CI->getValue()+1));
Chris Lattner02446fc2010-01-04 07:37:31 +00002148 case ICmpInst::ICMP_UGE:
Nick Lewyckyd8d15842011-02-28 06:20:05 +00002149 assert(!CI->isMinValue(false)); // A >=u MIN -> TRUE
Chris Lattner02446fc2010-01-04 07:37:31 +00002150 return new ICmpInst(ICmpInst::ICMP_UGT, Op0,
Jakub Staszak3facc432013-06-06 20:18:46 +00002151 Builder->getInt(CI->getValue()-1));
Chris Lattner02446fc2010-01-04 07:37:31 +00002152 case ICmpInst::ICMP_SGE:
Nick Lewyckyd8d15842011-02-28 06:20:05 +00002153 assert(!CI->isMinValue(true)); // A >=s MIN -> TRUE
Chris Lattner02446fc2010-01-04 07:37:31 +00002154 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
Jakub Staszak3facc432013-06-06 20:18:46 +00002155 Builder->getInt(CI->getValue()-1));
Chris Lattner02446fc2010-01-04 07:37:31 +00002156 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002157
Chris Lattner02446fc2010-01-04 07:37:31 +00002158 // If this comparison is a normal comparison, it demands all
2159 // bits, if it is a sign bit comparison, it only demands the sign bit.
2160 bool UnusedBit;
2161 isSignBit = isSignBitCheck(I.getPredicate(), CI, UnusedBit);
2162 }
2163
2164 // See if we can fold the comparison based on range information we can get
2165 // by checking whether bits are known to be zero or one in the input.
2166 if (BitWidth != 0) {
2167 APInt Op0KnownZero(BitWidth, 0), Op0KnownOne(BitWidth, 0);
2168 APInt Op1KnownZero(BitWidth, 0), Op1KnownOne(BitWidth, 0);
2169
2170 if (SimplifyDemandedBits(I.getOperandUse(0),
Owen Andersonda1c1222011-01-11 00:36:45 +00002171 DemandedBitsLHSMask(I, BitWidth, isSignBit),
Chris Lattner02446fc2010-01-04 07:37:31 +00002172 Op0KnownZero, Op0KnownOne, 0))
2173 return &I;
2174 if (SimplifyDemandedBits(I.getOperandUse(1),
2175 APInt::getAllOnesValue(BitWidth),
2176 Op1KnownZero, Op1KnownOne, 0))
2177 return &I;
2178
2179 // Given the known and unknown bits, compute a range that the LHS could be
2180 // in. Compute the Min, Max and RHS values based on the known bits. For the
2181 // EQ and NE we use unsigned values.
2182 APInt Op0Min(BitWidth, 0), Op0Max(BitWidth, 0);
2183 APInt Op1Min(BitWidth, 0), Op1Max(BitWidth, 0);
2184 if (I.isSigned()) {
2185 ComputeSignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2186 Op0Min, Op0Max);
2187 ComputeSignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2188 Op1Min, Op1Max);
2189 } else {
2190 ComputeUnsignedMinMaxValuesFromKnownBits(Op0KnownZero, Op0KnownOne,
2191 Op0Min, Op0Max);
2192 ComputeUnsignedMinMaxValuesFromKnownBits(Op1KnownZero, Op1KnownOne,
2193 Op1Min, Op1Max);
2194 }
2195
2196 // If Min and Max are known to be the same, then SimplifyDemandedBits
2197 // figured out that the LHS is a constant. Just constant fold this now so
2198 // that code below can assume that Min != Max.
2199 if (!isa<Constant>(Op0) && Op0Min == Op0Max)
2200 return new ICmpInst(I.getPredicate(),
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002201 ConstantInt::get(Op0->getType(), Op0Min), Op1);
Chris Lattner02446fc2010-01-04 07:37:31 +00002202 if (!isa<Constant>(Op1) && Op1Min == Op1Max)
2203 return new ICmpInst(I.getPredicate(), Op0,
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002204 ConstantInt::get(Op1->getType(), Op1Min));
Chris Lattner02446fc2010-01-04 07:37:31 +00002205
2206 // Based on the range information we know about the LHS, see if we can
Nick Lewyckyd8d15842011-02-28 06:20:05 +00002207 // simplify this comparison. For example, (x&4) < 8 is always true.
Chris Lattner02446fc2010-01-04 07:37:31 +00002208 switch (I.getPredicate()) {
2209 default: llvm_unreachable("Unknown icmp opcode!");
Chris Lattner75d8f592010-11-21 06:44:42 +00002210 case ICmpInst::ICMP_EQ: {
Chris Lattner02446fc2010-01-04 07:37:31 +00002211 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002212 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002213
Chris Lattner75d8f592010-11-21 06:44:42 +00002214 // If all bits are known zero except for one, then we know at most one
2215 // bit is set. If the comparison is against zero, then this is a check
2216 // to see if *that* bit is set.
2217 APInt Op0KnownZeroInverted = ~Op0KnownZero;
2218 if (~Op1KnownZero == 0 && Op0KnownZeroInverted.isPowerOf2()) {
2219 // If the LHS is an AND with the same constant, look through it.
2220 Value *LHS = 0;
2221 ConstantInt *LHSC = 0;
2222 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2223 LHSC->getValue() != Op0KnownZeroInverted)
2224 LHS = Op0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002225
Chris Lattner75d8f592010-11-21 06:44:42 +00002226 // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
Chris Lattner79b967b2010-11-23 02:42:04 +00002227 // then turn "((1 << x)&8) == 0" into "x != 3".
Chris Lattner75d8f592010-11-21 06:44:42 +00002228 Value *X = 0;
2229 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
2230 unsigned CmpVal = Op0KnownZeroInverted.countTrailingZeros();
Chris Lattner79b967b2010-11-23 02:42:04 +00002231 return new ICmpInst(ICmpInst::ICMP_NE, X,
Chris Lattner75d8f592010-11-21 06:44:42 +00002232 ConstantInt::get(X->getType(), CmpVal));
2233 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002234
Chris Lattner75d8f592010-11-21 06:44:42 +00002235 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
Chris Lattner79b967b2010-11-23 02:42:04 +00002236 // then turn "((8 >>u x)&1) == 0" into "x != 3".
Chris Lattnerb20c0b52011-02-10 05:23:05 +00002237 const APInt *CI;
Chris Lattner75d8f592010-11-21 06:44:42 +00002238 if (Op0KnownZeroInverted == 1 &&
Chris Lattnerb20c0b52011-02-10 05:23:05 +00002239 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattner79b967b2010-11-23 02:42:04 +00002240 return new ICmpInst(ICmpInst::ICMP_NE, X,
Chris Lattnerb20c0b52011-02-10 05:23:05 +00002241 ConstantInt::get(X->getType(),
2242 CI->countTrailingZeros()));
Chris Lattner75d8f592010-11-21 06:44:42 +00002243 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002244
Chris Lattner02446fc2010-01-04 07:37:31 +00002245 break;
Chris Lattner75d8f592010-11-21 06:44:42 +00002246 }
2247 case ICmpInst::ICMP_NE: {
Chris Lattner02446fc2010-01-04 07:37:31 +00002248 if (Op0Max.ult(Op1Min) || Op0Min.ugt(Op1Max))
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002249 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002250
Chris Lattner75d8f592010-11-21 06:44:42 +00002251 // If all bits are known zero except for one, then we know at most one
2252 // bit is set. If the comparison is against zero, then this is a check
2253 // to see if *that* bit is set.
2254 APInt Op0KnownZeroInverted = ~Op0KnownZero;
2255 if (~Op1KnownZero == 0 && Op0KnownZeroInverted.isPowerOf2()) {
2256 // If the LHS is an AND with the same constant, look through it.
2257 Value *LHS = 0;
2258 ConstantInt *LHSC = 0;
2259 if (!match(Op0, m_And(m_Value(LHS), m_ConstantInt(LHSC))) ||
2260 LHSC->getValue() != Op0KnownZeroInverted)
2261 LHS = Op0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002262
Chris Lattner75d8f592010-11-21 06:44:42 +00002263 // If the LHS is 1 << x, and we know the result is a power of 2 like 8,
Chris Lattner79b967b2010-11-23 02:42:04 +00002264 // then turn "((1 << x)&8) != 0" into "x == 3".
Chris Lattner75d8f592010-11-21 06:44:42 +00002265 Value *X = 0;
2266 if (match(LHS, m_Shl(m_One(), m_Value(X)))) {
2267 unsigned CmpVal = Op0KnownZeroInverted.countTrailingZeros();
Chris Lattner79b967b2010-11-23 02:42:04 +00002268 return new ICmpInst(ICmpInst::ICMP_EQ, X,
Chris Lattner75d8f592010-11-21 06:44:42 +00002269 ConstantInt::get(X->getType(), CmpVal));
2270 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002271
Chris Lattner75d8f592010-11-21 06:44:42 +00002272 // If the LHS is 8 >>u x, and we know the result is a power of 2 like 1,
Chris Lattner79b967b2010-11-23 02:42:04 +00002273 // then turn "((8 >>u x)&1) != 0" into "x == 3".
Chris Lattnerb20c0b52011-02-10 05:23:05 +00002274 const APInt *CI;
Chris Lattner75d8f592010-11-21 06:44:42 +00002275 if (Op0KnownZeroInverted == 1 &&
Chris Lattnerb20c0b52011-02-10 05:23:05 +00002276 match(LHS, m_LShr(m_Power2(CI), m_Value(X))))
Chris Lattner79b967b2010-11-23 02:42:04 +00002277 return new ICmpInst(ICmpInst::ICMP_EQ, X,
Chris Lattnerb20c0b52011-02-10 05:23:05 +00002278 ConstantInt::get(X->getType(),
2279 CI->countTrailingZeros()));
Chris Lattner75d8f592010-11-21 06:44:42 +00002280 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002281
Chris Lattner02446fc2010-01-04 07:37:31 +00002282 break;
Chris Lattner75d8f592010-11-21 06:44:42 +00002283 }
Chris Lattner02446fc2010-01-04 07:37:31 +00002284 case ICmpInst::ICMP_ULT:
2285 if (Op0Max.ult(Op1Min)) // A <u B -> true if max(A) < min(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002286 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002287 if (Op0Min.uge(Op1Max)) // A <u B -> false if min(A) >= max(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002288 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002289 if (Op1Min == Op0Max) // A <u B -> A != B if max(A) == min(B)
2290 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2291 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2292 if (Op1Max == Op0Min+1) // A <u C -> A == C-1 if min(A)+1 == C
2293 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszak3facc432013-06-06 20:18:46 +00002294 Builder->getInt(CI->getValue()-1));
Chris Lattner02446fc2010-01-04 07:37:31 +00002295
2296 // (x <u 2147483648) -> (x >s -1) -> true if sign bit clear
2297 if (CI->isMinValue(true))
2298 return new ICmpInst(ICmpInst::ICMP_SGT, Op0,
2299 Constant::getAllOnesValue(Op0->getType()));
2300 }
2301 break;
2302 case ICmpInst::ICMP_UGT:
2303 if (Op0Min.ugt(Op1Max)) // A >u B -> true if min(A) > max(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002304 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002305 if (Op0Max.ule(Op1Min)) // A >u B -> false if max(A) <= max(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002306 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002307
2308 if (Op1Max == Op0Min) // A >u B -> A != B if min(A) == max(B)
2309 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2310 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2311 if (Op1Min == Op0Max-1) // A >u C -> A == C+1 if max(a)-1 == C
2312 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszak3facc432013-06-06 20:18:46 +00002313 Builder->getInt(CI->getValue()+1));
Chris Lattner02446fc2010-01-04 07:37:31 +00002314
2315 // (x >u 2147483647) -> (x <s 0) -> true if sign bit set
2316 if (CI->isMaxValue(true))
2317 return new ICmpInst(ICmpInst::ICMP_SLT, Op0,
2318 Constant::getNullValue(Op0->getType()));
2319 }
2320 break;
2321 case ICmpInst::ICMP_SLT:
2322 if (Op0Max.slt(Op1Min)) // A <s B -> true if max(A) < min(C)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002323 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002324 if (Op0Min.sge(Op1Max)) // A <s B -> false if min(A) >= max(C)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002325 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002326 if (Op1Min == Op0Max) // A <s B -> A != B if max(A) == min(B)
2327 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2328 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2329 if (Op1Max == Op0Min+1) // A <s C -> A == C-1 if min(A)+1 == C
2330 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszak3facc432013-06-06 20:18:46 +00002331 Builder->getInt(CI->getValue()-1));
Chris Lattner02446fc2010-01-04 07:37:31 +00002332 }
2333 break;
2334 case ICmpInst::ICMP_SGT:
2335 if (Op0Min.sgt(Op1Max)) // A >s B -> true if min(A) > max(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002336 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002337 if (Op0Max.sle(Op1Min)) // A >s B -> false if max(A) <= min(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002338 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002339
2340 if (Op1Max == Op0Min) // A >s B -> A != B if min(A) == max(B)
2341 return new ICmpInst(ICmpInst::ICMP_NE, Op0, Op1);
2342 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
2343 if (Op1Min == Op0Max-1) // A >s C -> A == C+1 if max(A)-1 == C
2344 return new ICmpInst(ICmpInst::ICMP_EQ, Op0,
Jakub Staszak3facc432013-06-06 20:18:46 +00002345 Builder->getInt(CI->getValue()+1));
Chris Lattner02446fc2010-01-04 07:37:31 +00002346 }
2347 break;
2348 case ICmpInst::ICMP_SGE:
2349 assert(!isa<ConstantInt>(Op1) && "ICMP_SGE with ConstantInt not folded!");
2350 if (Op0Min.sge(Op1Max)) // A >=s B -> true if min(A) >= max(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002351 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002352 if (Op0Max.slt(Op1Min)) // A >=s B -> false if max(A) < min(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002353 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002354 break;
2355 case ICmpInst::ICMP_SLE:
2356 assert(!isa<ConstantInt>(Op1) && "ICMP_SLE with ConstantInt not folded!");
2357 if (Op0Max.sle(Op1Min)) // A <=s B -> true if max(A) <= min(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002358 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002359 if (Op0Min.sgt(Op1Max)) // A <=s B -> false if min(A) > max(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002360 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002361 break;
2362 case ICmpInst::ICMP_UGE:
2363 assert(!isa<ConstantInt>(Op1) && "ICMP_UGE with ConstantInt not folded!");
2364 if (Op0Min.uge(Op1Max)) // A >=u B -> true if min(A) >= max(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002365 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002366 if (Op0Max.ult(Op1Min)) // A >=u B -> false if max(A) < min(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002367 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002368 break;
2369 case ICmpInst::ICMP_ULE:
2370 assert(!isa<ConstantInt>(Op1) && "ICMP_ULE with ConstantInt not folded!");
2371 if (Op0Max.ule(Op1Min)) // A <=u B -> true if max(A) <= min(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002372 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002373 if (Op0Min.ugt(Op1Max)) // A <=u B -> false if min(A) > max(B)
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002374 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Chris Lattner02446fc2010-01-04 07:37:31 +00002375 break;
2376 }
2377
2378 // Turn a signed comparison into an unsigned one if both operands
2379 // are known to have the same sign.
2380 if (I.isSigned() &&
2381 ((Op0KnownZero.isNegative() && Op1KnownZero.isNegative()) ||
2382 (Op0KnownOne.isNegative() && Op1KnownOne.isNegative())))
2383 return new ICmpInst(I.getUnsignedPredicate(), Op0, Op1);
2384 }
2385
2386 // Test if the ICmpInst instruction is used exclusively by a select as
2387 // part of a minimum or maximum operation. If so, refrain from doing
2388 // any other folding. This helps out other analyses which understand
2389 // non-obfuscated minimum and maximum idioms, such as ScalarEvolution
2390 // and CodeGen. And in this case, at least one of the comparison
2391 // operands has at least one user besides the compare (the select),
2392 // which would often largely negate the benefit of folding anyway.
2393 if (I.hasOneUse())
2394 if (SelectInst *SI = dyn_cast<SelectInst>(*I.use_begin()))
2395 if ((SI->getOperand(1) == Op0 && SI->getOperand(2) == Op1) ||
2396 (SI->getOperand(2) == Op0 && SI->getOperand(1) == Op1))
2397 return 0;
2398
2399 // See if we are doing a comparison between a constant and an instruction that
2400 // can be folded into the comparison.
2401 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002402 // Since the RHS is a ConstantInt (CI), if the left hand side is an
2403 // instruction, see if that instruction also has constants so that the
2404 // instruction can be folded into the icmp
Chris Lattner02446fc2010-01-04 07:37:31 +00002405 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2406 if (Instruction *Res = visitICmpInstWithInstAndIntCst(I, LHSI, CI))
2407 return Res;
2408 }
2409
2410 // Handle icmp with constant (but not simple integer constant) RHS
2411 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
2412 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
2413 switch (LHSI->getOpcode()) {
2414 case Instruction::GetElementPtr:
2415 // icmp pred GEP (P, int 0, int 0, int 0), null -> icmp pred P, null
2416 if (RHSC->isNullValue() &&
2417 cast<GetElementPtrInst>(LHSI)->hasAllZeroIndices())
2418 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2419 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2420 break;
2421 case Instruction::PHI:
2422 // Only fold icmp into the PHI if the phi and icmp are in the same
2423 // block. If in the same block, we're encouraging jump threading. If
2424 // not, we are just pessimizing the code by making an i1 phi.
2425 if (LHSI->getParent() == I.getParent())
Chris Lattner9922ccf2011-01-16 05:14:26 +00002426 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner02446fc2010-01-04 07:37:31 +00002427 return NV;
2428 break;
2429 case Instruction::Select: {
2430 // If either operand of the select is a constant, we can fold the
2431 // comparison into the select arms, which will cause one to be
2432 // constant folded and the select turned into a bitwise or.
2433 Value *Op1 = 0, *Op2 = 0;
2434 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1)))
2435 Op1 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2436 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2)))
2437 Op2 = ConstantExpr::getICmp(I.getPredicate(), C, RHSC);
2438
2439 // We only want to perform this transformation if it will not lead to
2440 // additional code. This is true if either both sides of the select
2441 // fold to a constant (in which case the icmp is replaced with a select
2442 // which will usually simplify) or this is the only user of the
2443 // select (in which case we are trading a select+icmp for a simpler
2444 // select+icmp).
2445 if ((Op1 && Op2) || (LHSI->hasOneUse() && (Op1 || Op2))) {
2446 if (!Op1)
2447 Op1 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(1),
2448 RHSC, I.getName());
2449 if (!Op2)
2450 Op2 = Builder->CreateICmp(I.getPredicate(), LHSI->getOperand(2),
2451 RHSC, I.getName());
2452 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
2453 }
2454 break;
2455 }
Chris Lattner02446fc2010-01-04 07:37:31 +00002456 case Instruction::IntToPtr:
2457 // icmp pred inttoptr(X), null -> icmp pred X, 0
2458 if (RHSC->isNullValue() && TD &&
Chandler Carruthece6c6b2012-11-01 08:07:29 +00002459 TD->getIntPtrType(RHSC->getContext()) ==
Chris Lattner02446fc2010-01-04 07:37:31 +00002460 LHSI->getOperand(0)->getType())
2461 return new ICmpInst(I.getPredicate(), LHSI->getOperand(0),
2462 Constant::getNullValue(LHSI->getOperand(0)->getType()));
2463 break;
2464
2465 case Instruction::Load:
2466 // Try to optimize things like "A[i] > 4" to index computations.
2467 if (GetElementPtrInst *GEP =
2468 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
2469 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
2470 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
2471 !cast<LoadInst>(LHSI)->isVolatile())
2472 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
2473 return Res;
2474 }
2475 break;
2476 }
2477 }
2478
2479 // If we can optimize a 'icmp GEP, P' or 'icmp P, GEP', do so now.
2480 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op0))
2481 if (Instruction *NI = FoldGEPICmp(GEP, Op1, I.getPredicate(), I))
2482 return NI;
2483 if (GEPOperator *GEP = dyn_cast<GEPOperator>(Op1))
2484 if (Instruction *NI = FoldGEPICmp(GEP, Op0,
2485 ICmpInst::getSwappedPredicate(I.getPredicate()), I))
2486 return NI;
2487
2488 // Test to see if the operands of the icmp are casted versions of other
2489 // values. If the ptr->ptr cast can be stripped off both arguments, we do so
2490 // now.
2491 if (BitCastInst *CI = dyn_cast<BitCastInst>(Op0)) {
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002492 if (Op0->getType()->isPointerTy() &&
2493 (isa<Constant>(Op1) || isa<BitCastInst>(Op1))) {
Chris Lattner02446fc2010-01-04 07:37:31 +00002494 // We keep moving the cast from the left operand over to the right
2495 // operand, where it can often be eliminated completely.
2496 Op0 = CI->getOperand(0);
2497
2498 // If operand #1 is a bitcast instruction, it must also be a ptr->ptr cast
2499 // so eliminate it as well.
2500 if (BitCastInst *CI2 = dyn_cast<BitCastInst>(Op1))
2501 Op1 = CI2->getOperand(0);
2502
2503 // If Op1 is a constant, we can fold the cast into the constant.
2504 if (Op0->getType() != Op1->getType()) {
2505 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
2506 Op1 = ConstantExpr::getBitCast(Op1C, Op0->getType());
2507 } else {
2508 // Otherwise, cast the RHS right before the icmp
2509 Op1 = Builder->CreateBitCast(Op1, Op0->getType());
2510 }
2511 }
2512 return new ICmpInst(I.getPredicate(), Op0, Op1);
2513 }
2514 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002515
Chris Lattner02446fc2010-01-04 07:37:31 +00002516 if (isa<CastInst>(Op0)) {
2517 // Handle the special case of: icmp (cast bool to X), <cst>
2518 // This comes up when you have code like
2519 // int X = A < B;
2520 // if (X) ...
2521 // For generality, we handle any zero-extension of any operand comparison
2522 // with a constant or another cast from the same type.
2523 if (isa<Constant>(Op1) || isa<CastInst>(Op1))
2524 if (Instruction *R = visitICmpInstWithCastAndCast(I))
2525 return R;
2526 }
Chris Lattner02446fc2010-01-04 07:37:31 +00002527
Duncan Sandsa7724332011-02-17 07:46:37 +00002528 // Special logic for binary operators.
2529 BinaryOperator *BO0 = dyn_cast<BinaryOperator>(Op0);
2530 BinaryOperator *BO1 = dyn_cast<BinaryOperator>(Op1);
2531 if (BO0 || BO1) {
2532 CmpInst::Predicate Pred = I.getPredicate();
2533 bool NoOp0WrapProblem = false, NoOp1WrapProblem = false;
2534 if (BO0 && isa<OverflowingBinaryOperator>(BO0))
2535 NoOp0WrapProblem = ICmpInst::isEquality(Pred) ||
2536 (CmpInst::isUnsigned(Pred) && BO0->hasNoUnsignedWrap()) ||
2537 (CmpInst::isSigned(Pred) && BO0->hasNoSignedWrap());
2538 if (BO1 && isa<OverflowingBinaryOperator>(BO1))
2539 NoOp1WrapProblem = ICmpInst::isEquality(Pred) ||
2540 (CmpInst::isUnsigned(Pred) && BO1->hasNoUnsignedWrap()) ||
2541 (CmpInst::isSigned(Pred) && BO1->hasNoSignedWrap());
2542
2543 // Analyze the case when either Op0 or Op1 is an add instruction.
2544 // Op0 = A + B (or A and B are null); Op1 = C + D (or C and D are null).
2545 Value *A = 0, *B = 0, *C = 0, *D = 0;
2546 if (BO0 && BO0->getOpcode() == Instruction::Add)
2547 A = BO0->getOperand(0), B = BO0->getOperand(1);
2548 if (BO1 && BO1->getOpcode() == Instruction::Add)
2549 C = BO1->getOperand(0), D = BO1->getOperand(1);
2550
2551 // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2552 if ((A == Op1 || B == Op1) && NoOp0WrapProblem)
2553 return new ICmpInst(Pred, A == Op1 ? B : A,
2554 Constant::getNullValue(Op1->getType()));
2555
2556 // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2557 if ((C == Op0 || D == Op0) && NoOp1WrapProblem)
2558 return new ICmpInst(Pred, Constant::getNullValue(Op0->getType()),
2559 C == Op0 ? D : C);
2560
Duncan Sands39a7de72011-02-18 16:25:37 +00002561 // icmp (X+Y), (X+Z) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandsa7724332011-02-17 07:46:37 +00002562 if (A && C && (A == C || A == D || B == C || B == D) &&
2563 NoOp0WrapProblem && NoOp1WrapProblem &&
2564 // Try not to increase register pressure.
2565 BO0->hasOneUse() && BO1->hasOneUse()) {
2566 // Determine Y and Z in the form icmp (X+Y), (X+Z).
Duncan Sandsafe45392012-11-16 18:55:49 +00002567 Value *Y, *Z;
2568 if (A == C) {
Duncan Sands4f0dfbb2012-11-16 20:53:08 +00002569 // C + B == C + D -> B == D
Duncan Sandsafe45392012-11-16 18:55:49 +00002570 Y = B;
2571 Z = D;
2572 } else if (A == D) {
Duncan Sands4f0dfbb2012-11-16 20:53:08 +00002573 // D + B == C + D -> B == C
Duncan Sandsafe45392012-11-16 18:55:49 +00002574 Y = B;
2575 Z = C;
2576 } else if (B == C) {
Duncan Sands4f0dfbb2012-11-16 20:53:08 +00002577 // A + C == C + D -> A == D
Duncan Sandsafe45392012-11-16 18:55:49 +00002578 Y = A;
2579 Z = D;
Duncan Sands4f0dfbb2012-11-16 20:53:08 +00002580 } else {
2581 assert(B == D);
2582 // A + D == C + D -> A == C
Duncan Sandsafe45392012-11-16 18:55:49 +00002583 Y = A;
2584 Z = C;
2585 }
Duncan Sandsa7724332011-02-17 07:46:37 +00002586 return new ICmpInst(Pred, Y, Z);
2587 }
2588
David Majnemer59b11c42013-04-11 20:05:46 +00002589 // icmp slt (X + -1), Y -> icmp sle X, Y
2590 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLT &&
2591 match(B, m_AllOnes()))
2592 return new ICmpInst(CmpInst::ICMP_SLE, A, Op1);
2593
2594 // icmp sge (X + -1), Y -> icmp sgt X, Y
2595 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGE &&
2596 match(B, m_AllOnes()))
2597 return new ICmpInst(CmpInst::ICMP_SGT, A, Op1);
2598
2599 // icmp sle (X + 1), Y -> icmp slt X, Y
2600 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SLE &&
2601 match(B, m_One()))
2602 return new ICmpInst(CmpInst::ICMP_SLT, A, Op1);
2603
2604 // icmp sgt (X + 1), Y -> icmp sge X, Y
2605 if (A && NoOp0WrapProblem && Pred == CmpInst::ICMP_SGT &&
2606 match(B, m_One()))
2607 return new ICmpInst(CmpInst::ICMP_SGE, A, Op1);
2608
2609 // if C1 has greater magnitude than C2:
2610 // icmp (X + C1), (Y + C2) -> icmp (X + C3), Y
2611 // s.t. C3 = C1 - C2
2612 //
2613 // if C2 has greater magnitude than C1:
2614 // icmp (X + C1), (Y + C2) -> icmp X, (Y + C3)
2615 // s.t. C3 = C2 - C1
2616 if (A && C && NoOp0WrapProblem && NoOp1WrapProblem &&
2617 (BO0->hasOneUse() || BO1->hasOneUse()) && !I.isUnsigned())
2618 if (ConstantInt *C1 = dyn_cast<ConstantInt>(B))
2619 if (ConstantInt *C2 = dyn_cast<ConstantInt>(D)) {
2620 const APInt &AP1 = C1->getValue();
2621 const APInt &AP2 = C2->getValue();
2622 if (AP1.isNegative() == AP2.isNegative()) {
2623 APInt AP1Abs = C1->getValue().abs();
2624 APInt AP2Abs = C2->getValue().abs();
2625 if (AP1Abs.uge(AP2Abs)) {
2626 ConstantInt *C3 = Builder->getInt(AP1 - AP2);
2627 Value *NewAdd = Builder->CreateNSWAdd(A, C3);
2628 return new ICmpInst(Pred, NewAdd, C);
2629 } else {
2630 ConstantInt *C3 = Builder->getInt(AP2 - AP1);
2631 Value *NewAdd = Builder->CreateNSWAdd(C, C3);
2632 return new ICmpInst(Pred, A, NewAdd);
2633 }
2634 }
2635 }
2636
2637
Duncan Sandsa7724332011-02-17 07:46:37 +00002638 // Analyze the case when either Op0 or Op1 is a sub instruction.
2639 // Op0 = A - B (or A and B are null); Op1 = C - D (or C and D are null).
2640 A = 0; B = 0; C = 0; D = 0;
2641 if (BO0 && BO0->getOpcode() == Instruction::Sub)
2642 A = BO0->getOperand(0), B = BO0->getOperand(1);
2643 if (BO1 && BO1->getOpcode() == Instruction::Sub)
2644 C = BO1->getOperand(0), D = BO1->getOperand(1);
2645
Duncan Sands39a7de72011-02-18 16:25:37 +00002646 // icmp (X-Y), X -> icmp 0, Y for equalities or if there is no overflow.
2647 if (A == Op1 && NoOp0WrapProblem)
2648 return new ICmpInst(Pred, Constant::getNullValue(Op1->getType()), B);
2649
2650 // icmp X, (X-Y) -> icmp Y, 0 for equalities or if there is no overflow.
2651 if (C == Op0 && NoOp1WrapProblem)
2652 return new ICmpInst(Pred, D, Constant::getNullValue(Op0->getType()));
2653
2654 // icmp (Y-X), (Z-X) -> icmp Y, Z for equalities or if there is no overflow.
Duncan Sandsa7724332011-02-17 07:46:37 +00002655 if (B && D && B == D && NoOp0WrapProblem && NoOp1WrapProblem &&
2656 // Try not to increase register pressure.
2657 BO0->hasOneUse() && BO1->hasOneUse())
2658 return new ICmpInst(Pred, A, C);
2659
Duncan Sands39a7de72011-02-18 16:25:37 +00002660 // icmp (X-Y), (X-Z) -> icmp Z, Y for equalities or if there is no overflow.
2661 if (A && C && A == C && NoOp0WrapProblem && NoOp1WrapProblem &&
2662 // Try not to increase register pressure.
2663 BO0->hasOneUse() && BO1->hasOneUse())
2664 return new ICmpInst(Pred, D, B);
2665
Nick Lewycky9feda172011-03-05 04:28:48 +00002666 BinaryOperator *SRem = NULL;
Nick Lewyckydcf77572011-03-08 06:29:47 +00002667 // icmp (srem X, Y), Y
Nick Lewycky9feda172011-03-05 04:28:48 +00002668 if (BO0 && BO0->getOpcode() == Instruction::SRem &&
2669 Op1 == BO0->getOperand(1))
2670 SRem = BO0;
Nick Lewyckydcf77572011-03-08 06:29:47 +00002671 // icmp Y, (srem X, Y)
Nick Lewycky9feda172011-03-05 04:28:48 +00002672 else if (BO1 && BO1->getOpcode() == Instruction::SRem &&
2673 Op0 == BO1->getOperand(1))
2674 SRem = BO1;
2675 if (SRem) {
2676 // We don't check hasOneUse to avoid increasing register pressure because
2677 // the value we use is the same value this instruction was already using.
2678 switch (SRem == BO0 ? ICmpInst::getSwappedPredicate(Pred) : Pred) {
2679 default: break;
2680 case ICmpInst::ICMP_EQ:
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002681 return ReplaceInstUsesWith(I, ConstantInt::getFalse(I.getType()));
Nick Lewycky9feda172011-03-05 04:28:48 +00002682 case ICmpInst::ICMP_NE:
Nick Lewyckyd01f50f2011-03-06 03:36:19 +00002683 return ReplaceInstUsesWith(I, ConstantInt::getTrue(I.getType()));
Nick Lewycky9feda172011-03-05 04:28:48 +00002684 case ICmpInst::ICMP_SGT:
2685 case ICmpInst::ICMP_SGE:
2686 return new ICmpInst(ICmpInst::ICMP_SGT, SRem->getOperand(1),
2687 Constant::getAllOnesValue(SRem->getType()));
2688 case ICmpInst::ICMP_SLT:
2689 case ICmpInst::ICMP_SLE:
2690 return new ICmpInst(ICmpInst::ICMP_SLT, SRem->getOperand(1),
2691 Constant::getNullValue(SRem->getType()));
2692 }
2693 }
2694
Duncan Sandsa7724332011-02-17 07:46:37 +00002695 if (BO0 && BO1 && BO0->getOpcode() == BO1->getOpcode() &&
2696 BO0->hasOneUse() && BO1->hasOneUse() &&
2697 BO0->getOperand(1) == BO1->getOperand(1)) {
2698 switch (BO0->getOpcode()) {
2699 default: break;
2700 case Instruction::Add:
2701 case Instruction::Sub:
2702 case Instruction::Xor:
2703 if (I.isEquality()) // a+x icmp eq/ne b+x --> a icmp b
2704 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
2705 BO1->getOperand(0));
2706 // icmp u/s (a ^ signbit), (b ^ signbit) --> icmp s/u a, b
2707 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
2708 if (CI->getValue().isSignBit()) {
2709 ICmpInst::Predicate Pred = I.isSigned()
2710 ? I.getUnsignedPredicate()
2711 : I.getSignedPredicate();
2712 return new ICmpInst(Pred, BO0->getOperand(0),
2713 BO1->getOperand(0));
Chris Lattner02446fc2010-01-04 07:37:31 +00002714 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002715
Chris Lattnerc73b24d2011-07-15 06:08:15 +00002716 if (CI->isMaxValue(true)) {
Duncan Sandsa7724332011-02-17 07:46:37 +00002717 ICmpInst::Predicate Pred = I.isSigned()
2718 ? I.getUnsignedPredicate()
2719 : I.getSignedPredicate();
2720 Pred = I.getSwappedPredicate(Pred);
2721 return new ICmpInst(Pred, BO0->getOperand(0),
2722 BO1->getOperand(0));
2723 }
Chris Lattner02446fc2010-01-04 07:37:31 +00002724 }
Duncan Sandsa7724332011-02-17 07:46:37 +00002725 break;
2726 case Instruction::Mul:
2727 if (!I.isEquality())
2728 break;
2729
2730 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO0->getOperand(1))) {
2731 // a * Cst icmp eq/ne b * Cst --> a & Mask icmp b & Mask
2732 // Mask = -1 >> count-trailing-zeros(Cst).
2733 if (!CI->isZero() && !CI->isOne()) {
2734 const APInt &AP = CI->getValue();
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002735 ConstantInt *Mask = ConstantInt::get(I.getContext(),
Duncan Sandsa7724332011-02-17 07:46:37 +00002736 APInt::getLowBitsSet(AP.getBitWidth(),
2737 AP.getBitWidth() -
2738 AP.countTrailingZeros()));
2739 Value *And1 = Builder->CreateAnd(BO0->getOperand(0), Mask);
2740 Value *And2 = Builder->CreateAnd(BO1->getOperand(0), Mask);
2741 return new ICmpInst(I.getPredicate(), And1, And2);
2742 }
2743 }
2744 break;
Nick Lewycky58bfcdb2011-03-05 05:19:11 +00002745 case Instruction::UDiv:
2746 case Instruction::LShr:
2747 if (I.isSigned())
2748 break;
2749 // fall-through
2750 case Instruction::SDiv:
2751 case Instruction::AShr:
Eli Friedmanb6e7cd62011-05-05 21:59:18 +00002752 if (!BO0->isExact() || !BO1->isExact())
Nick Lewycky58bfcdb2011-03-05 05:19:11 +00002753 break;
2754 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
2755 BO1->getOperand(0));
2756 case Instruction::Shl: {
2757 bool NUW = BO0->hasNoUnsignedWrap() && BO1->hasNoUnsignedWrap();
2758 bool NSW = BO0->hasNoSignedWrap() && BO1->hasNoSignedWrap();
2759 if (!NUW && !NSW)
2760 break;
2761 if (!NSW && I.isSigned())
2762 break;
2763 return new ICmpInst(I.getPredicate(), BO0->getOperand(0),
2764 BO1->getOperand(0));
2765 }
Chris Lattner02446fc2010-01-04 07:37:31 +00002766 }
2767 }
2768 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002769
Chris Lattner02446fc2010-01-04 07:37:31 +00002770 { Value *A, *B;
David Majnemerfb1cd692013-04-12 17:25:07 +00002771 // Transform (A & ~B) == 0 --> (A & B) != 0
2772 // and (A & ~B) != 0 --> (A & B) == 0
2773 // if A is a power of 2.
2774 if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
2775 match(Op1, m_Zero()) && isKnownToBeAPowerOfTwo(A) && I.isEquality())
2776 return new ICmpInst(I.getInversePredicate(),
2777 Builder->CreateAnd(A, B),
2778 Op1);
2779
Chris Lattnerfdb5b012011-01-15 05:41:33 +00002780 // ~x < ~y --> y < x
2781 // ~x < cst --> ~cst < x
2782 if (match(Op0, m_Not(m_Value(A)))) {
2783 if (match(Op1, m_Not(m_Value(B))))
2784 return new ICmpInst(I.getPredicate(), B, A);
Chris Lattner27a98482011-01-15 05:42:47 +00002785 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(Op1))
Chris Lattnerfdb5b012011-01-15 05:41:33 +00002786 return new ICmpInst(I.getPredicate(), ConstantExpr::getNot(RHSC), A);
2787 }
Chris Lattnere5cbdca2010-12-19 19:37:52 +00002788
2789 // (a+b) <u a --> llvm.uadd.with.overflow.
2790 // (a+b) <u b --> llvm.uadd.with.overflow.
2791 if (I.getPredicate() == ICmpInst::ICMP_ULT &&
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002792 match(Op0, m_Add(m_Value(A), m_Value(B))) &&
Chris Lattnere5cbdca2010-12-19 19:37:52 +00002793 (Op1 == A || Op1 == B))
2794 if (Instruction *R = ProcessUAddIdiom(I, Op0, *this))
2795 return R;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002796
Chris Lattnere5cbdca2010-12-19 19:37:52 +00002797 // a >u (a+b) --> llvm.uadd.with.overflow.
2798 // b >u (a+b) --> llvm.uadd.with.overflow.
2799 if (I.getPredicate() == ICmpInst::ICMP_UGT &&
2800 match(Op1, m_Add(m_Value(A), m_Value(B))) &&
2801 (Op0 == A || Op0 == B))
2802 if (Instruction *R = ProcessUAddIdiom(I, Op1, *this))
2803 return R;
Chris Lattner02446fc2010-01-04 07:37:31 +00002804 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002805
Chris Lattner02446fc2010-01-04 07:37:31 +00002806 if (I.isEquality()) {
2807 Value *A, *B, *C, *D;
Duncan Sands39a7de72011-02-18 16:25:37 +00002808
Chris Lattner02446fc2010-01-04 07:37:31 +00002809 if (match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
2810 if (A == Op1 || B == Op1) { // (A^B) == A -> B == 0
2811 Value *OtherVal = A == Op1 ? B : A;
2812 return new ICmpInst(I.getPredicate(), OtherVal,
2813 Constant::getNullValue(A->getType()));
2814 }
2815
2816 if (match(Op1, m_Xor(m_Value(C), m_Value(D)))) {
2817 // A^c1 == C^c2 --> A == C^(c1^c2)
2818 ConstantInt *C1, *C2;
2819 if (match(B, m_ConstantInt(C1)) &&
2820 match(D, m_ConstantInt(C2)) && Op1->hasOneUse()) {
Jakub Staszak3facc432013-06-06 20:18:46 +00002821 Constant *NC = Builder->getInt(C1->getValue() ^ C2->getValue());
Benjamin Kramera9390a42011-09-27 20:39:19 +00002822 Value *Xor = Builder->CreateXor(C, NC);
Chris Lattner02446fc2010-01-04 07:37:31 +00002823 return new ICmpInst(I.getPredicate(), A, Xor);
2824 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002825
Chris Lattner02446fc2010-01-04 07:37:31 +00002826 // A^B == A^D -> B == D
2827 if (A == C) return new ICmpInst(I.getPredicate(), B, D);
2828 if (A == D) return new ICmpInst(I.getPredicate(), B, C);
2829 if (B == C) return new ICmpInst(I.getPredicate(), A, D);
2830 if (B == D) return new ICmpInst(I.getPredicate(), A, C);
2831 }
2832 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002833
Chris Lattner02446fc2010-01-04 07:37:31 +00002834 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
2835 (A == Op0 || B == Op0)) {
2836 // A == (A^B) -> B == 0
2837 Value *OtherVal = A == Op0 ? B : A;
2838 return new ICmpInst(I.getPredicate(), OtherVal,
2839 Constant::getNullValue(A->getType()));
2840 }
2841
Chris Lattner02446fc2010-01-04 07:37:31 +00002842 // (X&Z) == (Y&Z) -> (X^Y) & Z == 0
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002843 if (match(Op0, m_OneUse(m_And(m_Value(A), m_Value(B)))) &&
Chris Lattner5036ce42011-04-26 20:02:45 +00002844 match(Op1, m_OneUse(m_And(m_Value(C), m_Value(D))))) {
Chris Lattner02446fc2010-01-04 07:37:31 +00002845 Value *X = 0, *Y = 0, *Z = 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002846
Chris Lattner02446fc2010-01-04 07:37:31 +00002847 if (A == C) {
2848 X = B; Y = D; Z = A;
2849 } else if (A == D) {
2850 X = B; Y = C; Z = A;
2851 } else if (B == C) {
2852 X = A; Y = D; Z = B;
2853 } else if (B == D) {
2854 X = A; Y = C; Z = B;
2855 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002856
Chris Lattner02446fc2010-01-04 07:37:31 +00002857 if (X) { // Build (X^Y) & Z
Benjamin Kramera9390a42011-09-27 20:39:19 +00002858 Op1 = Builder->CreateXor(X, Y);
2859 Op1 = Builder->CreateAnd(Op1, Z);
Chris Lattner02446fc2010-01-04 07:37:31 +00002860 I.setOperand(0, Op1);
2861 I.setOperand(1, Constant::getNullValue(Op1->getType()));
2862 return &I;
2863 }
2864 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002865
Benjamin Kramer66821d92012-06-10 20:35:00 +00002866 // Transform (zext A) == (B & (1<<X)-1) --> A == (trunc B)
Benjamin Kramer7a99b462012-06-11 08:01:25 +00002867 // and (B & (1<<X)-1) == (zext A) --> A == (trunc B)
Benjamin Kramer66821d92012-06-10 20:35:00 +00002868 ConstantInt *Cst1;
Benjamin Kramer7a99b462012-06-11 08:01:25 +00002869 if ((Op0->hasOneUse() &&
2870 match(Op0, m_ZExt(m_Value(A))) &&
2871 match(Op1, m_And(m_Value(B), m_ConstantInt(Cst1)))) ||
2872 (Op1->hasOneUse() &&
2873 match(Op0, m_And(m_Value(B), m_ConstantInt(Cst1))) &&
2874 match(Op1, m_ZExt(m_Value(A))))) {
Benjamin Kramer66821d92012-06-10 20:35:00 +00002875 APInt Pow2 = Cst1->getValue() + 1;
2876 if (Pow2.isPowerOf2() && isa<IntegerType>(A->getType()) &&
2877 Pow2.logBase2() == cast<IntegerType>(A->getType())->getBitWidth())
2878 return new ICmpInst(I.getPredicate(), A,
2879 Builder->CreateTrunc(B, A->getType()));
2880 }
2881
Chris Lattner325eeb12011-04-26 20:18:20 +00002882 // Transform "icmp eq (trunc (lshr(X, cst1)), cst" to
2883 // "icmp (and X, mask), cst"
2884 uint64_t ShAmt = 0;
Chris Lattner325eeb12011-04-26 20:18:20 +00002885 if (Op0->hasOneUse() &&
2886 match(Op0, m_Trunc(m_OneUse(m_LShr(m_Value(A),
2887 m_ConstantInt(ShAmt))))) &&
2888 match(Op1, m_ConstantInt(Cst1)) &&
2889 // Only do this when A has multiple uses. This is most important to do
2890 // when it exposes other optimizations.
2891 !A->hasOneUse()) {
2892 unsigned ASize =cast<IntegerType>(A->getType())->getPrimitiveSizeInBits();
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002893
Chris Lattner325eeb12011-04-26 20:18:20 +00002894 if (ShAmt < ASize) {
2895 APInt MaskV =
2896 APInt::getLowBitsSet(ASize, Op0->getType()->getPrimitiveSizeInBits());
2897 MaskV <<= ShAmt;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002898
Chris Lattner325eeb12011-04-26 20:18:20 +00002899 APInt CmpV = Cst1->getValue().zext(ASize);
2900 CmpV <<= ShAmt;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002901
Chris Lattner325eeb12011-04-26 20:18:20 +00002902 Value *Mask = Builder->CreateAnd(A, Builder->getInt(MaskV));
2903 return new ICmpInst(I.getPredicate(), Mask, Builder->getInt(CmpV));
2904 }
2905 }
Chris Lattner02446fc2010-01-04 07:37:31 +00002906 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002907
Chris Lattner02446fc2010-01-04 07:37:31 +00002908 {
2909 Value *X; ConstantInt *Cst;
2910 // icmp X+Cst, X
2911 if (match(Op0, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op1 == X)
2912 return FoldICmpAddOpCst(I, X, Cst, I.getPredicate(), Op0);
2913
2914 // icmp X, X+Cst
2915 if (match(Op1, m_Add(m_Value(X), m_ConstantInt(Cst))) && Op0 == X)
2916 return FoldICmpAddOpCst(I, X, Cst, I.getSwappedPredicate(), Op1);
2917 }
2918 return Changed ? &I : 0;
2919}
2920
2921
2922
2923
2924
2925
2926/// FoldFCmp_IntToFP_Cst - Fold fcmp ([us]itofp x, cst) if possible.
2927///
2928Instruction *InstCombiner::FoldFCmp_IntToFP_Cst(FCmpInst &I,
2929 Instruction *LHSI,
2930 Constant *RHSC) {
2931 if (!isa<ConstantFP>(RHSC)) return 0;
2932 const APFloat &RHS = cast<ConstantFP>(RHSC)->getValueAPF();
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002933
Chris Lattner02446fc2010-01-04 07:37:31 +00002934 // Get the width of the mantissa. We don't want to hack on conversions that
2935 // might lose information from the integer, e.g. "i64 -> float"
2936 int MantissaWidth = LHSI->getType()->getFPMantissaWidth();
2937 if (MantissaWidth == -1) return 0; // Unknown.
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002938
Chris Lattner02446fc2010-01-04 07:37:31 +00002939 // Check to see that the input is converted from an integer type that is small
2940 // enough that preserves all bits. TODO: check here for "known" sign bits.
2941 // This would allow us to handle (fptosi (x >>s 62) to float) if x is i64 f.e.
2942 unsigned InputSize = LHSI->getOperand(0)->getType()->getScalarSizeInBits();
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002943
Chris Lattner02446fc2010-01-04 07:37:31 +00002944 // If this is a uitofp instruction, we need an extra bit to hold the sign.
2945 bool LHSUnsigned = isa<UIToFPInst>(LHSI);
2946 if (LHSUnsigned)
2947 ++InputSize;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002948
Chris Lattner02446fc2010-01-04 07:37:31 +00002949 // If the conversion would lose info, don't hack on this.
2950 if ((int)InputSize > MantissaWidth)
2951 return 0;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002952
Chris Lattner02446fc2010-01-04 07:37:31 +00002953 // Otherwise, we can potentially simplify the comparison. We know that it
2954 // will always come through as an integer value and we know the constant is
2955 // not a NAN (it would have been previously simplified).
2956 assert(!RHS.isNaN() && "NaN comparison not already folded!");
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002957
Chris Lattner02446fc2010-01-04 07:37:31 +00002958 ICmpInst::Predicate Pred;
2959 switch (I.getPredicate()) {
2960 default: llvm_unreachable("Unexpected predicate!");
2961 case FCmpInst::FCMP_UEQ:
2962 case FCmpInst::FCMP_OEQ:
2963 Pred = ICmpInst::ICMP_EQ;
2964 break;
2965 case FCmpInst::FCMP_UGT:
2966 case FCmpInst::FCMP_OGT:
2967 Pred = LHSUnsigned ? ICmpInst::ICMP_UGT : ICmpInst::ICMP_SGT;
2968 break;
2969 case FCmpInst::FCMP_UGE:
2970 case FCmpInst::FCMP_OGE:
2971 Pred = LHSUnsigned ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_SGE;
2972 break;
2973 case FCmpInst::FCMP_ULT:
2974 case FCmpInst::FCMP_OLT:
2975 Pred = LHSUnsigned ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_SLT;
2976 break;
2977 case FCmpInst::FCMP_ULE:
2978 case FCmpInst::FCMP_OLE:
2979 Pred = LHSUnsigned ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_SLE;
2980 break;
2981 case FCmpInst::FCMP_UNE:
2982 case FCmpInst::FCMP_ONE:
2983 Pred = ICmpInst::ICMP_NE;
2984 break;
2985 case FCmpInst::FCMP_ORD:
Jakub Staszak3facc432013-06-06 20:18:46 +00002986 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner02446fc2010-01-04 07:37:31 +00002987 case FCmpInst::FCMP_UNO:
Jakub Staszak3facc432013-06-06 20:18:46 +00002988 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner02446fc2010-01-04 07:37:31 +00002989 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002990
Chris Lattnerdb125cf2011-07-18 04:54:35 +00002991 IntegerType *IntTy = cast<IntegerType>(LHSI->getOperand(0)->getType());
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002992
Chris Lattner02446fc2010-01-04 07:37:31 +00002993 // Now we know that the APFloat is a normal number, zero or inf.
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002994
Chris Lattner02446fc2010-01-04 07:37:31 +00002995 // See if the FP constant is too large for the integer. For example,
2996 // comparing an i8 to 300.0.
2997 unsigned IntWidth = IntTy->getScalarSizeInBits();
Jim Grosbach0cc4a952011-09-30 18:09:53 +00002998
Chris Lattner02446fc2010-01-04 07:37:31 +00002999 if (!LHSUnsigned) {
3000 // If the RHS value is > SignedMax, fold the comparison. This handles +INF
3001 // and large values.
Michael Gottesman4dfc2572013-06-27 21:58:19 +00003002 APFloat SMax(RHS.getSemantics());
Chris Lattner02446fc2010-01-04 07:37:31 +00003003 SMax.convertFromAPInt(APInt::getSignedMaxValue(IntWidth), true,
3004 APFloat::rmNearestTiesToEven);
3005 if (SMax.compare(RHS) == APFloat::cmpLessThan) { // smax < 13123.0
3006 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SLT ||
3007 Pred == ICmpInst::ICMP_SLE)
Jakub Staszak3facc432013-06-06 20:18:46 +00003008 return ReplaceInstUsesWith(I, Builder->getTrue());
3009 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner02446fc2010-01-04 07:37:31 +00003010 }
3011 } else {
3012 // If the RHS value is > UnsignedMax, fold the comparison. This handles
3013 // +INF and large values.
Michael Gottesman4dfc2572013-06-27 21:58:19 +00003014 APFloat UMax(RHS.getSemantics());
Chris Lattner02446fc2010-01-04 07:37:31 +00003015 UMax.convertFromAPInt(APInt::getMaxValue(IntWidth), false,
3016 APFloat::rmNearestTiesToEven);
3017 if (UMax.compare(RHS) == APFloat::cmpLessThan) { // umax < 13123.0
3018 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_ULT ||
3019 Pred == ICmpInst::ICMP_ULE)
Jakub Staszak3facc432013-06-06 20:18:46 +00003020 return ReplaceInstUsesWith(I, Builder->getTrue());
3021 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner02446fc2010-01-04 07:37:31 +00003022 }
3023 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00003024
Chris Lattner02446fc2010-01-04 07:37:31 +00003025 if (!LHSUnsigned) {
3026 // See if the RHS value is < SignedMin.
Michael Gottesman4dfc2572013-06-27 21:58:19 +00003027 APFloat SMin(RHS.getSemantics());
Chris Lattner02446fc2010-01-04 07:37:31 +00003028 SMin.convertFromAPInt(APInt::getSignedMinValue(IntWidth), true,
3029 APFloat::rmNearestTiesToEven);
3030 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // smin > 12312.0
3031 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_SGT ||
3032 Pred == ICmpInst::ICMP_SGE)
Jakub Staszak3facc432013-06-06 20:18:46 +00003033 return ReplaceInstUsesWith(I, Builder->getTrue());
3034 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner02446fc2010-01-04 07:37:31 +00003035 }
Devang Patela2e0f6b2012-02-13 23:05:18 +00003036 } else {
3037 // See if the RHS value is < UnsignedMin.
Michael Gottesman4dfc2572013-06-27 21:58:19 +00003038 APFloat SMin(RHS.getSemantics());
Devang Patela2e0f6b2012-02-13 23:05:18 +00003039 SMin.convertFromAPInt(APInt::getMinValue(IntWidth), true,
3040 APFloat::rmNearestTiesToEven);
3041 if (SMin.compare(RHS) == APFloat::cmpGreaterThan) { // umin > 12312.0
3042 if (Pred == ICmpInst::ICMP_NE || Pred == ICmpInst::ICMP_UGT ||
3043 Pred == ICmpInst::ICMP_UGE)
Jakub Staszak3facc432013-06-06 20:18:46 +00003044 return ReplaceInstUsesWith(I, Builder->getTrue());
3045 return ReplaceInstUsesWith(I, Builder->getFalse());
Devang Patela2e0f6b2012-02-13 23:05:18 +00003046 }
Chris Lattner02446fc2010-01-04 07:37:31 +00003047 }
3048
3049 // Okay, now we know that the FP constant fits in the range [SMIN, SMAX] or
3050 // [0, UMAX], but it may still be fractional. See if it is fractional by
3051 // casting the FP value to the integer value and back, checking for equality.
3052 // Don't do this for zero, because -0.0 is not fractional.
3053 Constant *RHSInt = LHSUnsigned
3054 ? ConstantExpr::getFPToUI(RHSC, IntTy)
3055 : ConstantExpr::getFPToSI(RHSC, IntTy);
3056 if (!RHS.isZero()) {
3057 bool Equal = LHSUnsigned
3058 ? ConstantExpr::getUIToFP(RHSInt, RHSC->getType()) == RHSC
3059 : ConstantExpr::getSIToFP(RHSInt, RHSC->getType()) == RHSC;
3060 if (!Equal) {
3061 // If we had a comparison against a fractional value, we have to adjust
3062 // the compare predicate and sometimes the value. RHSC is rounded towards
3063 // zero at this point.
3064 switch (Pred) {
3065 default: llvm_unreachable("Unexpected integer comparison!");
3066 case ICmpInst::ICMP_NE: // (float)int != 4.4 --> true
Jakub Staszak3facc432013-06-06 20:18:46 +00003067 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner02446fc2010-01-04 07:37:31 +00003068 case ICmpInst::ICMP_EQ: // (float)int == 4.4 --> false
Jakub Staszak3facc432013-06-06 20:18:46 +00003069 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner02446fc2010-01-04 07:37:31 +00003070 case ICmpInst::ICMP_ULE:
3071 // (float)int <= 4.4 --> int <= 4
3072 // (float)int <= -4.4 --> false
3073 if (RHS.isNegative())
Jakub Staszak3facc432013-06-06 20:18:46 +00003074 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner02446fc2010-01-04 07:37:31 +00003075 break;
3076 case ICmpInst::ICMP_SLE:
3077 // (float)int <= 4.4 --> int <= 4
3078 // (float)int <= -4.4 --> int < -4
3079 if (RHS.isNegative())
3080 Pred = ICmpInst::ICMP_SLT;
3081 break;
3082 case ICmpInst::ICMP_ULT:
3083 // (float)int < -4.4 --> false
3084 // (float)int < 4.4 --> int <= 4
3085 if (RHS.isNegative())
Jakub Staszak3facc432013-06-06 20:18:46 +00003086 return ReplaceInstUsesWith(I, Builder->getFalse());
Chris Lattner02446fc2010-01-04 07:37:31 +00003087 Pred = ICmpInst::ICMP_ULE;
3088 break;
3089 case ICmpInst::ICMP_SLT:
3090 // (float)int < -4.4 --> int < -4
3091 // (float)int < 4.4 --> int <= 4
3092 if (!RHS.isNegative())
3093 Pred = ICmpInst::ICMP_SLE;
3094 break;
3095 case ICmpInst::ICMP_UGT:
3096 // (float)int > 4.4 --> int > 4
3097 // (float)int > -4.4 --> true
3098 if (RHS.isNegative())
Jakub Staszak3facc432013-06-06 20:18:46 +00003099 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner02446fc2010-01-04 07:37:31 +00003100 break;
3101 case ICmpInst::ICMP_SGT:
3102 // (float)int > 4.4 --> int > 4
3103 // (float)int > -4.4 --> int >= -4
3104 if (RHS.isNegative())
3105 Pred = ICmpInst::ICMP_SGE;
3106 break;
3107 case ICmpInst::ICMP_UGE:
3108 // (float)int >= -4.4 --> true
3109 // (float)int >= 4.4 --> int > 4
Bob Wilsonf12c95a2012-08-07 22:35:16 +00003110 if (RHS.isNegative())
Jakub Staszak3facc432013-06-06 20:18:46 +00003111 return ReplaceInstUsesWith(I, Builder->getTrue());
Chris Lattner02446fc2010-01-04 07:37:31 +00003112 Pred = ICmpInst::ICMP_UGT;
3113 break;
3114 case ICmpInst::ICMP_SGE:
3115 // (float)int >= -4.4 --> int >= -4
3116 // (float)int >= 4.4 --> int > 4
3117 if (!RHS.isNegative())
3118 Pred = ICmpInst::ICMP_SGT;
3119 break;
3120 }
3121 }
3122 }
3123
3124 // Lower this FP comparison into an appropriate integer version of the
3125 // comparison.
3126 return new ICmpInst(Pred, LHSI->getOperand(0), RHSInt);
3127}
3128
3129Instruction *InstCombiner::visitFCmpInst(FCmpInst &I) {
3130 bool Changed = false;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00003131
Chris Lattner02446fc2010-01-04 07:37:31 +00003132 /// Orders the operands of the compare so that they are listed from most
3133 /// complex to least complex. This puts constants before unary operators,
3134 /// before binary operators.
3135 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1))) {
3136 I.swapOperands();
3137 Changed = true;
3138 }
3139
3140 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Jim Grosbach0cc4a952011-09-30 18:09:53 +00003141
Chris Lattner02446fc2010-01-04 07:37:31 +00003142 if (Value *V = SimplifyFCmpInst(I.getPredicate(), Op0, Op1, TD))
3143 return ReplaceInstUsesWith(I, V);
3144
3145 // Simplify 'fcmp pred X, X'
3146 if (Op0 == Op1) {
3147 switch (I.getPredicate()) {
3148 default: llvm_unreachable("Unknown predicate!");
3149 case FCmpInst::FCMP_UNO: // True if unordered: isnan(X) | isnan(Y)
3150 case FCmpInst::FCMP_ULT: // True if unordered or less than
3151 case FCmpInst::FCMP_UGT: // True if unordered or greater than
3152 case FCmpInst::FCMP_UNE: // True if unordered or not equal
3153 // Canonicalize these to be 'fcmp uno %X, 0.0'.
3154 I.setPredicate(FCmpInst::FCMP_UNO);
3155 I.setOperand(1, Constant::getNullValue(Op0->getType()));
3156 return &I;
Jim Grosbach0cc4a952011-09-30 18:09:53 +00003157
Chris Lattner02446fc2010-01-04 07:37:31 +00003158 case FCmpInst::FCMP_ORD: // True if ordered (no nans)
3159 case FCmpInst::FCMP_OEQ: // True if ordered and equal
3160 case FCmpInst::FCMP_OGE: // True if ordered and greater than or equal
3161 case FCmpInst::FCMP_OLE: // True if ordered and less than or equal
3162 // Canonicalize these to be 'fcmp ord %X, 0.0'.
3163 I.setPredicate(FCmpInst::FCMP_ORD);
3164 I.setOperand(1, Constant::getNullValue(Op0->getType()));
3165 return &I;
3166 }
3167 }
Jim Grosbach0cc4a952011-09-30 18:09:53 +00003168
Chris Lattner02446fc2010-01-04 07:37:31 +00003169 // Handle fcmp with constant RHS
3170 if (Constant *RHSC = dyn_cast<Constant>(Op1)) {
3171 if (Instruction *LHSI = dyn_cast<Instruction>(Op0))
3172 switch (LHSI->getOpcode()) {
Benjamin Kramerb194bdc2011-03-31 10:12:07 +00003173 case Instruction::FPExt: {
3174 // fcmp (fpext x), C -> fcmp x, (fptrunc C) if fptrunc is lossless
3175 FPExtInst *LHSExt = cast<FPExtInst>(LHSI);
3176 ConstantFP *RHSF = dyn_cast<ConstantFP>(RHSC);
3177 if (!RHSF)
3178 break;
3179
3180 const fltSemantics *Sem;
3181 // FIXME: This shouldn't be here.
Dan Gohmance163392011-12-17 00:04:22 +00003182 if (LHSExt->getSrcTy()->isHalfTy())
3183 Sem = &APFloat::IEEEhalf;
3184 else if (LHSExt->getSrcTy()->isFloatTy())
Benjamin Kramerb194bdc2011-03-31 10:12:07 +00003185 Sem = &APFloat::IEEEsingle;
3186 else if (LHSExt->getSrcTy()->isDoubleTy())
3187 Sem = &APFloat::IEEEdouble;
3188 else if (LHSExt->getSrcTy()->isFP128Ty())
3189 Sem = &APFloat::IEEEquad;
3190 else if (LHSExt->getSrcTy()->isX86_FP80Ty())
3191 Sem = &APFloat::x87DoubleExtended;
Ulrich Weigand3467b9f2012-10-30 12:33:18 +00003192 else if (LHSExt->getSrcTy()->isPPC_FP128Ty())
3193 Sem = &APFloat::PPCDoubleDouble;
Benjamin Kramerb194bdc2011-03-31 10:12:07 +00003194 else
3195 break;
3196
3197 bool Lossy;
3198 APFloat F = RHSF->getValueAPF();
3199 F.convert(*Sem, APFloat::rmNearestTiesToEven, &Lossy);
3200
Jim Grosbachcbf676b2011-09-30 18:45:50 +00003201 // Avoid lossy conversions and denormals. Zero is a special case
3202 // that's OK to convert.
Jim Grosbach68e05fb2011-09-30 19:58:46 +00003203 APFloat Fabs = F;
3204 Fabs.clearSign();
Benjamin Kramerb194bdc2011-03-31 10:12:07 +00003205 if (!Lossy &&
Jim Grosbach68e05fb2011-09-30 19:58:46 +00003206 ((Fabs.compare(APFloat::getSmallestNormalized(*Sem)) !=
3207 APFloat::cmpLessThan) || Fabs.isZero()))
Jim Grosbachcbf676b2011-09-30 18:45:50 +00003208
Benjamin Kramerb194bdc2011-03-31 10:12:07 +00003209 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3210 ConstantFP::get(RHSC->getContext(), F));
3211 break;
3212 }
Chris Lattner02446fc2010-01-04 07:37:31 +00003213 case Instruction::PHI:
3214 // Only fold fcmp into the PHI if the phi and fcmp are in the same
3215 // block. If in the same block, we're encouraging jump threading. If
3216 // not, we are just pessimizing the code by making an i1 phi.
3217 if (LHSI->getParent() == I.getParent())
Chris Lattner9922ccf2011-01-16 05:14:26 +00003218 if (Instruction *NV = FoldOpIntoPhi(I))
Chris Lattner02446fc2010-01-04 07:37:31 +00003219 return NV;
3220 break;
3221 case Instruction::SIToFP:
3222 case Instruction::UIToFP:
3223 if (Instruction *NV = FoldFCmp_IntToFP_Cst(I, LHSI, RHSC))
3224 return NV;
3225 break;
3226 case Instruction::Select: {
3227 // If either operand of the select is a constant, we can fold the
3228 // comparison into the select arms, which will cause one to be
3229 // constant folded and the select turned into a bitwise or.
3230 Value *Op1 = 0, *Op2 = 0;
3231 if (LHSI->hasOneUse()) {
3232 if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(1))) {
3233 // Fold the known value into the constant operand.
3234 Op1 = ConstantExpr::getCompare(I.getPredicate(), C, RHSC);
3235 // Insert a new FCmp of the other select operand.
3236 Op2 = Builder->CreateFCmp(I.getPredicate(),
3237 LHSI->getOperand(2), RHSC, I.getName());
3238 } else if (Constant *C = dyn_cast<Constant>(LHSI->getOperand(2))) {
3239 // Fold the known value into the constant operand.
3240 Op2 = ConstantExpr::getCompare(I.getPredicate(), C, RHSC);
3241 // Insert a new FCmp of the other select operand.
3242 Op1 = Builder->CreateFCmp(I.getPredicate(), LHSI->getOperand(1),
3243 RHSC, I.getName());
3244 }
3245 }
3246
3247 if (Op1)
3248 return SelectInst::Create(LHSI->getOperand(0), Op1, Op2);
3249 break;
3250 }
Benjamin Kramer0db50182011-03-31 10:12:15 +00003251 case Instruction::FSub: {
3252 // fcmp pred (fneg x), C -> fcmp swap(pred) x, -C
3253 Value *Op;
3254 if (match(LHSI, m_FNeg(m_Value(Op))))
3255 return new FCmpInst(I.getSwappedPredicate(), Op,
3256 ConstantExpr::getFNeg(RHSC));
3257 break;
3258 }
Dan Gohman39516a62010-02-24 06:46:09 +00003259 case Instruction::Load:
3260 if (GetElementPtrInst *GEP =
3261 dyn_cast<GetElementPtrInst>(LHSI->getOperand(0))) {
3262 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0)))
3263 if (GV->isConstant() && GV->hasDefinitiveInitializer() &&
3264 !cast<LoadInst>(LHSI)->isVolatile())
3265 if (Instruction *Res = FoldCmpLoadFromIndexedGlobal(GEP, GV, I))
3266 return Res;
3267 }
3268 break;
Benjamin Kramer00abcd32012-08-18 20:06:47 +00003269 case Instruction::Call: {
3270 CallInst *CI = cast<CallInst>(LHSI);
3271 LibFunc::Func Func;
3272 // Various optimization for fabs compared with zero.
Benjamin Kramera4b57172012-08-18 22:04:34 +00003273 if (RHSC->isNullValue() && CI->getCalledFunction() &&
Benjamin Kramer00abcd32012-08-18 20:06:47 +00003274 TLI->getLibFunc(CI->getCalledFunction()->getName(), Func) &&
3275 TLI->has(Func)) {
3276 if (Func == LibFunc::fabs || Func == LibFunc::fabsf ||
3277 Func == LibFunc::fabsl) {
3278 switch (I.getPredicate()) {
3279 default: break;
3280 // fabs(x) < 0 --> false
3281 case FCmpInst::FCMP_OLT:
3282 return ReplaceInstUsesWith(I, Builder->getFalse());
3283 // fabs(x) > 0 --> x != 0
3284 case FCmpInst::FCMP_OGT:
3285 return new FCmpInst(FCmpInst::FCMP_ONE, CI->getArgOperand(0),
3286 RHSC);
3287 // fabs(x) <= 0 --> x == 0
3288 case FCmpInst::FCMP_OLE:
3289 return new FCmpInst(FCmpInst::FCMP_OEQ, CI->getArgOperand(0),
3290 RHSC);
3291 // fabs(x) >= 0 --> !isnan(x)
3292 case FCmpInst::FCMP_OGE:
3293 return new FCmpInst(FCmpInst::FCMP_ORD, CI->getArgOperand(0),
3294 RHSC);
3295 // fabs(x) == 0 --> x == 0
3296 // fabs(x) != 0 --> x != 0
3297 case FCmpInst::FCMP_OEQ:
3298 case FCmpInst::FCMP_UEQ:
3299 case FCmpInst::FCMP_ONE:
3300 case FCmpInst::FCMP_UNE:
3301 return new FCmpInst(I.getPredicate(), CI->getArgOperand(0),
3302 RHSC);
3303 }
3304 }
3305 }
3306 }
Chris Lattner02446fc2010-01-04 07:37:31 +00003307 }
Chris Lattner02446fc2010-01-04 07:37:31 +00003308 }
3309
Benjamin Kramer00e00d62011-03-31 10:46:03 +00003310 // fcmp pred (fneg x), (fneg y) -> fcmp swap(pred) x, y
Benjamin Kramer68b4bd02011-03-31 10:12:22 +00003311 Value *X, *Y;
3312 if (match(Op0, m_FNeg(m_Value(X))) && match(Op1, m_FNeg(m_Value(Y))))
Benjamin Kramer00e00d62011-03-31 10:46:03 +00003313 return new FCmpInst(I.getSwappedPredicate(), X, Y);
Benjamin Kramer68b4bd02011-03-31 10:12:22 +00003314
Benjamin Kramercd0274c2011-03-31 10:11:58 +00003315 // fcmp (fpext x), (fpext y) -> fcmp x, y
3316 if (FPExtInst *LHSExt = dyn_cast<FPExtInst>(Op0))
3317 if (FPExtInst *RHSExt = dyn_cast<FPExtInst>(Op1))
3318 if (LHSExt->getSrcTy() == RHSExt->getSrcTy())
3319 return new FCmpInst(I.getPredicate(), LHSExt->getOperand(0),
3320 RHSExt->getOperand(0));
3321
Chris Lattner02446fc2010-01-04 07:37:31 +00003322 return Changed ? &I : 0;
3323}